Skip to content

Welcome to QuaEngine

Create a visual novel with QuaScript and TypeScript, starting with the editor and your first scene.

QuaEngine is a TypeScript visual novel engine with an Electron editor. Write dialogue and choices in QuaScript, compose audiovisual staging with plugins, and choose a Web, Cocos, Godot, or Native target.

Start here

TaskGuide
Create and run a projectQuick start
Write dialogue, interpolation, and choicesYour first scene
Compare rendering targetsPlatform guide (Chinese)
Explore authoring toolsEditor guide
Check implementation and platform limitsProject status (Chinese)

Three contracts

The engine owns story state. Scenes, dialogue, choices, progress, and audio intent belong to the engine/store. Renderers project that state and send player intents through @quajs/pipeline.

Features are plugins. Backgrounds, audio, animation, gallery, inventory, and achievements are optional features. Projects enable the capabilities they need.

Content ships in packages. Quack builds assets into QPKs. Supported targets can mount incremental content as Runtime QPK Packages, with engine-owned trust checks, dependencies, migrations, and lifecycle.

Language coverage

The quick start, first-scene tutorial, and Editor handbook are available in English and Chinese. Other creator guides are currently in Chinese; package references retain their source language. Links marked “Chinese” open those original pages. The language selector enables only translations that exist for the current page.

APIs are still evolving. Pin your dependencies and validate reading, branching, and save/load on your own target devices before release.

View / improve this page on GitHub