- Lua 65.3%
- COBOL 27.2%
- C 5.6%
- GLSL 1.5%
- AngelScript 0.2%
| .github | ||
| anims | ||
| bitmaps | ||
| common | ||
| doc | ||
| effects | ||
| features | ||
| fonts | ||
| gamedata | ||
| icons | ||
| language | ||
| luaintro | ||
| luarules | ||
| luaui | ||
| modelmaterials | ||
| modelmaterials_gl4 | ||
| modules | ||
| music | ||
| objects3d | ||
| recoil-lua-library@5e9f3f3121 | ||
| scripts | ||
| shaders | ||
| sidepics | ||
| singleplayer | ||
| sounds | ||
| tools | ||
| types | ||
| unitbasedefs | ||
| unitpics | ||
| units | ||
| unittextures | ||
| weapons | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .luacheckrc | ||
| .luarc.json | ||
| .travis.yml | ||
| AI_POLICY.md | ||
| changelog.txt | ||
| cmdcolors_icexuick.txt | ||
| EngineOptions.lua | ||
| init.lua | ||
| LICENSE.md | ||
| license_bitmaps.txt | ||
| license_general.txt | ||
| license_icons.txt | ||
| license_music.txt | ||
| license_sounds.txt | ||
| license_unitpics.txt | ||
| luaai.lua | ||
| luaui.lua | ||
| modinfo.lua | ||
| modoptions.lua | ||
| README.md | ||
| springignore.txt | ||
Beyond-All-Reason
Open source RTS game built on top of the Recoil RTS Engine
Where to download
https://www.beyondallreason.info/download
How to play
https://www.beyondallreason.info/guides
Development Quick Start
Beyond All Reason (BAR), consists of 2 primary components, the lobby (Chobby - https://github.com/beyond-all-reason/BYAR-Chobby) and the game code itself (this repository).
The game runs on top of the Recoil engine https://github.com/beyond-all-reason/spring.
In order to develop the game (this repository) you first need a working install of the lobby/launcher. There are 2 ways to do this:
-
Download the full BAR application from the website and run it. This is probably what you will have done if you have previously installed and played the game.
-
OR if you want to develop the lobby client, follow the guide in the Chobby README. First download a release of Chobby and then launch Chobby, this will automatically download and install the engine and other dependencies.
Once you have a working install of BAR you need a local development copy of the game code to work with. This code will live in the BAR install directory.
-
To find the BAR install directory simply open the launcher (not full game) and click the "Open install directory" button. This is one of the 3 buttons (
Toggle logandUpload logare the other 2). For Windows installs this might be your user'sAppData/Local/Programs/Beyond-All-Reason/datadirectory. -
In the BAR install directory create the empty file
devmode.txt. E.g:AppData/Local/Programs/Beyond-All-Reason/data/devmode.txt -
In the BAR install directory in the
datafolder in thegamessub-directory (creategamesif it doesn't exist) clone the code for this repository into a directory with a name ending in.sdd. For example:
git clone --recurse-submodules https://github.com/beyond-all-reason/Beyond-All-Reason.git BAR.sdd
Ensure that you have the correct path by looking for the file Beyond-All-Reason/data/games/BAR.sdd/modinfo.lua
-
Now you have the game code launch the full game from the launcher as normal. Then go to
Settings > Developer > Singleplayerand selectBeyond All Reason Dev. -
Now you can launch a match normally through the game UI. This match will use the dev copy of the LUA code which is in
BAR-install-directory/data/games/BAR.sdd. -
If developing Chobby also clone the code into the
gamesdirectory. Follow the guide in the Chobby README. -
(Optional, Advanced) If you want to run automated integration tests, see the testing documentation
More on the .sdd directory to run raw LUA and the structure expected by Spring Engine is documented here.