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
RoukakuPlayer
RoukakuPlayer is the runtime host. It loads packaged data and manages windows, devices and platform events.
RoukakuVN
RoukakuVN is the visual novel module. Authors write .roukaku sources, which are cooked and then executed by the same VnSession.
RoukakuEditor
RoukakuEditor offers text, story graph, timeline, Details and a standalone Player preview; panel edits are written back to the same source.
roukakuroukaku is the command-line tool for script and UI checks, cooking, package builds and platform bundles.
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
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 editorcargo install --locked --path Engine/Source/Programs/roukaku-cli --bin roukaku
roukaku --help- See Quick start to cook, package and play the public sample. Quick start
- RoukakuEngine development is currently paused, and there are no binary releases. The source and docs stay public, and you can build from source with the quick start. Project status
- A platform declared in the configuration has not necessarily had its windowing, input, audio and save/load verified on a device.
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.
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.