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.
-
On Windows,
BUILD.batwill automatically install a private 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
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 - please follow the link and read the documentation for the project to understand how it works and how to contribute to this build script.