Getting Started

Stranger path: this site → clone → hello cube → hello_juni / Spark → editor. Budget about 30 minutes on a machine with a working GPU driver (Metal / Vulkan / DX12 via wgpu). The engine and editor run from source on macOS, Windows, and Linux. Reach player zips are macOS and Windows only.

  1. 1. Install Rust

    Install stable Rust with rustup. Kerabit pins the toolchain in rust-toolchain.toml — rustup will pick it up on first cargo in the repo.

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    # Windows: rustup-init.exe from rustup.rs + VS Build Tools (C++/MSVC)
    rustc --version

    Moving a Mac checkout onto a PC: WINDOWS.md — same cargo commands; copy ~/.kerabit to %USERPROFILE%\.kerabit.

  2. 2. Clone the engine

    git clone https://github.com/AJpro774/kerabitengine.git
    cd kerabitengine
  3. 3. Hello cube (~2 min after first compile)

    First build downloads crates and compiles wgpu — expect several minutes once. After that, examples are fast.

    cargo run -p kerabit --example hello

    You should see an orange cube on a gray ground. Escape quits. Source: examples/hello.rs.

  4. 4. Scripting (3.0)

    cargo run -p kerabit --example hello_juni
    cargo run -p spark

    hello_juni spins a cube from a .juni file (statically typed; compiled to WASM in-process, so typos fail before Play). Spark is a short script-first game. Host API: Juni scripting.

  5. 5. Open the editor

    cargo run -p kerabit-editor

    Same command on macOS, Windows, or Linux — there is no editor zip. File → Open a level under games/reach/levels/. Orbit with right mouse, select an entity, press W for the move gizmo. See the Editor guide for Play, undo, Script panel, and prefabs.

  6. 6. Play the flagship games (optional)

    cargo run -p reach
    cargo run -p surge
    cargo run -p showcase

    Or skip cargo and grab a player zip from Downloads — macOS and Windows only.

Accept gate

If you completed steps 1–4 and saw the hello window plus the editor viewport, you are on the Summit stranger path. Next: API tour.