Command-line tools
The programs you run while making a cTurtle game. Most of the time you work in Studio, which runs these tools for you; use the command line to build in scripts or CI, write standalone BT programs, or use another editor.
| Tool | Use it to |
|---|---|
CTurtleStudio | Start cTurtle Studio, optionally opening a project. |
ctgame | Build your game into a desktop executable or a web build. |
ctbt | Run a BT script, or build it into a standalone program (tools, servers, utilities). |
bt-ui | Open a BT UI app in a window, with hot reload while you edit it. |
wasm-serve | Test a web build in your browser on your own machine. |
ctfont-pack | Combine TrueType fonts into one .ctfont with fallbacks. |
CTurtleHost | Run a game that has a native (C) game module outside Studio. |
| Editor integrations | Set up VS Code or a JetBrains IDE for BT: completion, errors, debugging. |
bt-lsp | Check BT scripts for errors in CI, or connect another editor. |
bt-dap | Debug BT code from an editor other than VS Code or JetBrains. |
| Engine environment | Environment variables for measuring performance, capturing frames and debugging a running game. |
Where the tools are
The Studio package contains CTurtleStudio, ctgame, ctbt and the
debugging tools. The VS Code extension and JetBrains plugin bundle their own
bt-lsp, bt-dap, ctbt and bt-run. The other tools come with a full
build of the cTurtle engine.
Keep each tool in the folder it was installed in: several of them find helper programs and engine files next to themselves.
Conventions
- Exit status 0 means success, 1 means the task failed (the message says why), and 2 means the command line was wrong.
- Messages start with the tool's name, for example
ctgame: .... - Related: Projects, Assets and game data, Building and publishing, Studio.