Getting Started

import { Steps, Aside, Tabs, TabItem } from ‘@astrojs/starlight/components’;

Welcome to Kani Game Engine — a visual-novel runtime for Rust built on top of Bevy and driven by KAG scripts with embedded Rhai expressions.

Prerequisites

Rust 1.80 or newer (install via rustup)
Cargo (bundled with Rust)
A Bevy-compatible platform (Windows, macOS, or Linux)

Installation

Create a new Bevy project
Terminal window
```
cargo new my-vn
cd my-vn
```

Add kani-runtime to your dependencies

cargo add kani-runtime
cargo add bevy

Or edit Cargo.toml manually:

[dependencies]
bevy = "0.15"
kani-runtime = "0.1"

Write your entry scenario

Create assets/scenario/first.ks:

*start
#Narrator
Welcome to my visual novel!
@l
The adventure begins here.
@l
@jump target=*start

Wire up the plugin

Replace the contents of src/main.rs:

use bevy::prelude::*;
use kani_runtime::{AssetBackend, KaniRuntimePlugin};
use std::path::PathBuf;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(KaniRuntimePlugin {
            asset_backend: AssetBackend::FileSystem {
                base: PathBuf::from("assets"),
            },
            entry_script: "scenario/first.ks".into(),
        })
        .run();
}

Run
Terminal window
```
cargo run
```

Project layout

my-vn/
├── Cargo.toml
├── src/
│   └── main.rs
└── assets/
    ├── scenario/
    │   └── first.ks      ← entry script
    ├── bg/               ← background images
    ├── chara/            ← character sprites
    ├── bgm/              ← background music
    └── se/               ← sound effects

Next steps

Read the KAG-Rhai Reference for every tag and expression.
Set up your editor with the LSP server for syntax highlighting and hover docs.