96d53c0f8b
A light version of the revert to help builds work on TGS3. (TGS3 builds were locking up on live, causing servers to be unable to testmerge or update things because of something to do with the recent juke build. I don't into the build tool, otherwise I'd be more clear)
/tg/station build script
This build script is the recommended way to compile the game, including not only the DM code but also the JavaScript and any other dependencies.
- VSCode:
a) Press
Ctrl+Shift+Bto build. b) PressF5to build and run with debugger attached. - Windows:
a) Double-click
BUILD.batin the repository root to build (will wait for a key press before it closes). b) Double-clicktools/build/build.batto build (will exit as soon as it finishes building). - Linux:
a) Run
tools/build/buildfrom the repository root.
The script will skip build steps whose inputs have not changed since the last run.
Getting list of available targets
You can get a list of all targets that you can build by running the following command:
tools/build/build --help
Dependencies
- On Windows,
build.batwill automatically install a private (vendored) copy of Node. - On Linux, install Node using your package manager or from https://nodejs.org/en/download/.
- On Linux, unless using tgs4 or later you will need to compile rust-g on the server and obtain a .so file, for instructions see https://github.com/tgstation/rust-g
Why?
We used to include compiled versions of the tgui JavaScript code in the Git repository so that the project could be compiled using BYOND only. These pre-compiled files tended to have merge conflicts for no good reason. Using a build script lets us avoid this problem, while keeping builds convenient for people who are not modifying tgui.
This build script is based on Juke Build - follow the link to read the documentation for the project and understand how it works and how to contribute.