Documentation
Getting started with GameCraft. The full manuals live in the repository.
Your first project
- Open GameCraft and choose New Project. Pick the 3D Core template.
- Choose GameObject > 3D Object > Cube and add a Rigidbody in the Inspector.
- Choose Assets > Create > MonoBehaviour Script and open it in the script editor.
- Press Play to run the scene.
- Choose File > Build Settings and click Build to export a standalone game.
Building from source
You need Node 22.19 or later, the stable Rust toolchain and the .NET 10 SDK. On macOS you also need the Xcode command-line tools.
git clone https://github.com/LassarLabs/gamecraft.git
cd gamecraft
npm install
source tools/env.sh
npm run dotnet:build
npm run tauri:dev
Command line
gamecraft-cli build <project> --target web
gamecraft-cli unity-import <unity-project> <output>
gamecraft-cli bake-lighting <project>
gamecraft-cli package search <query>
Running the tests
tools/quality-gates.sh # everything
cargo test --workspace # engine
npx vitest run # editor
tools/linux-test.sh # Linux, in Docker
Manuals
| Document | Contents |
|---|---|
| User guide | The editor, its panels and workflows |
| Scripting reference | The GameCraft SDK and the UnityEngine-compatible API |
| Architecture | How the engine, editor and runtime fit together |
| Unity parity | Unity features and their status |
| Limitations | Features that are partial or missing |
| Changelog | Changes in each release |