BYAR mutator for Chobby
- [Windows] and [Linux] https://github.com/beyond-all-reason/BYAR-Chobby/releases
-
Download using one of the links above and start the application.
-
Start the application once and launch the lobby. This will download the engine and other dependencies.
-
Open the install directory (there's a button for that in the launcher), and create a
games
directory, then clone this repository inside thegames
directory:
git clone https://github.com/beyond-all-reason/BYAR-Chobby.git BYAR-Chobby.sdd
This should result in the following directory being present: /path/to/install/dir/data/games/BYAR-Chobby.sdd/
under . (Beyond-All-Reason\data\games\BYAR-Chobby.sdd\LuaMenu\configs\gameConfig
should be a correct path)
NOTE: The games directory is data/games
under windows, and just games
under Linux.
-
Choose the
Dev Lobby
config from the launcher's top right dropdown menu which will run the lobby version on your PC. You can now develop and test any BYAR specific lobby functionality. -
If you want to develop Chobby itself, clone it in the
games
directory similar to step 3:
git clone https://github.com/Spring-Chobby/Chobby.git Chobby.sdd
You must also change the depend
table in BYAR-Chobby.sdd/modinfo.lua
to use Chobby $VERSION
instead of rapid://chobby:test
.
To enable debugmode, make an empty devmode.txt
in the already used game install directory (/data/
), and then the Settings/Developer
tab will appear in the lobby. All debug messages are visible in th Debug chat panel.
-
Make sure you've first finished setting up the lobby development environment (previous section)
-
Open the install directory, and inside the
games
directory clone the BAR game repository:
git clone https://github.com/beyond-all-reason/Beyond-All-Reason.git BAR.sdd
-
Start Chobby with
Dev Lobby
config, open theSettings/Developer
tab and in theSingleplayer
option chooseBeyond All Reason Dev
. The application title should change toBeyond All Reason Dev
. -
Choose Skirmish as you normally would - this will put you in a match against one Null AI by default - and start it. This should start Beyond All Reason with your local development version. You should see
Beyond All Reason $VERSION
in your window title.
- Use Zerobrane Studio dev env, open up any chobby Beyond-All-Reason\data*.lua file with Zerobrane studio, then set Project->Project Directory->From current file
- This allows you to ctrl+shift+f to find any text in all of chobby, useful
- Do NOT try to edit anything in Chobby.sdd! If you want to edit something in Chobby.sdd that is not overwritten by the mutator BYAR-Chobby (e.g. does not exist in BYAR-Chobby.sdd), then copy it over to BYAR-Chobby.sdd first and commit it (so we have a baseline).
- Open infolog.txt in notepad++ or anything to grep for errors.
- Modify a file in the
dist_cfg
folder (https://github.com/beyond-all-reason/BYAR-Chobby/tree/master/dist_cfg) on themaster
branch to trigger a launcher build. It should start a new action here: https://github.com/beyond-all-reason/BYAR-Chobby/actions - Wait until the build completely finishes (the action should be green and have a check), otherwise you might create an incomplete release.
- Make a release by finding the latest Draft here https://github.com/beyond-all-reason/BYAR-Chobby/releases , open it, click
Edit draft
and thenPublish Release
- Send new download links to .exe and .AppImage to BAR discord #website so download links on website can be updated.
- Note that pr-downloader is fetched from https://github.com/beyond-all-reason/spring-launcher