beyond-all-reason / beyond-all-reason/RecoilEngine

Document engine runtime dependencies and options

Open
#2,300 0 comments 0 reactions 0 assignees View on GitHub
area: documentation enhancement
Dominant language
C++
Stars
679
Forks
290
Avg merge
3d 2h
Merged PRs (30d)
40

Description

Currently there's no unified resource on what the engine expects to be present to minimally function, and what those requirements/dependencies are, examples of things we need to have available:

- Engine binary `spring` usage, options and input arguments (e.g. startscript)
- What kind of external dependencies to the engine binary are required or at least required to be known, e.g. basecontent, binary only works inside engine distribution folder or not, path to resource assets dir (writedir, datadir, etc)
- Anything else that is relevant for games using the engine at a lower level (e.g. developing lobby clients or hosting mechanisms) or engine developers to understand what to expect and how to configure their build/debug/release/run targets/workflows.

Contributor guide

Open the contributing guide

Research direction

Start by examining the engine binary `spring`, including its usage, options, and startscript input arguments. Identify the runtime requirements around basecontent, the engine distribution folder, and resource paths such as writedir and datadir, then document the expectations and configuration relevant to game, lobby, hosting, and engine workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.