Project-Shinkirou · Create new works

RoukakuEngine

An engine for creating and running native 2D works and visual novels.

A shared runtime provides scenes, tasks, clocks, input, text, media and resource management; RoukakuVN builds story flow, choices, staging, system pages and save/load on top of it.

Four parts

Get started

Install Rust (the toolchain is selected by rust-toolchain.toml) and a native C/C++ toolchain, prepare native dependencies with the build guide, then run from the repository root: build guide

Commands: Get started
cargo build --locked -p roukaku-cli -p roukaku-player -p roukaku-crash-reporter
cargo run --locked -p roukaku-cli -- --help
cargo run --locked --manifest-path Editor/Cargo.toml -p roukaku-editor -- Examples/NativeVN/project.yaml
cargo xtask check --workspace engine
cargo xtask check --workspace editor
Install the CLI into Cargo’s bin directory:
cargo install --locked --path Engine/Source/Programs/roukaku-cli --bin roukaku
roukaku --help

Relation to ShinkiEMU

ShinkiEMU is a separate product for running original engines. It uses RoukakuEngine’s shared libraries at a pinned Git revision; RoukakuEngine does not depend on ShinkiEMU.

ShinkiEMU

License

Project-owned code is available under MIT OR Apache-2.0, at your option. Third-party code and assets keep their own licenses and attribution.