Build and run

A build turns your project into a game that runs on its own, in a folder you can share.

The build profile

A build profile describes a build. A new project has one, named Default, and it already lists the main scene.

  1. Press Ctrl+Shift+B, or select Window ▸ Build ▸ Build Profiles.
  2. Under Scenes, the profile lists the scenes in the game. The first one, marked boot, is where the game starts.
    • Add Open Scenes adds every open scene that has been saved.
    • Add Scene... adds one by its path, such as Assets/Scenes/Level1.scene.
    • The arrow buttons move a scene up or down, and - removes it.

A build contains the listed scenes and the assets they use.

Build the game

Select Build And Run, or press Ctrl+B. The editor compiles your code for the game, packs the scenes and assets, and starts the game when the build is done. Build does the same without starting it, and Build All builds every profile.

The game is written to Builds/Default/ in the project folder. A Windows build holds:

FileWhat it is
MyProject.exeThe game, named after your project
Data/Content.slpakThe scenes and assets, packed into one file
Boot.jsonThe game's scene list and the scene it starts in
libc++.dll, libunwind.dllLibraries the game runs on
THIRD-PARTY-NOTICES.txtThe licenses of the open-source code in the engine

Share it

Zip the Builds/Default folder and send it. It holds everything the game needs; the person running it needs a computer that meets the requirements.

Note

Windows SmartScreen warns about programs it has not seen before, so the first person to run your game may see "Windows protected your PC". More info, then Run anyway starts it.

Building from the command line

The editor can build without opening its window. On Windows:

Shalltear.exe --project C:\Games\MyProject --build Default

--build can be repeated to build several profiles, --build-all builds every profile, and --output followed by a folder writes the build there.

Next, make a game from start to finish.