siglus_rs is an unofficial full Rust reimplementation of UK2, AVG32, RealLive, and SiglusEngine, with a primary focus on SiglusEngine.
This project is non-commercial and intended for research purposes.
Architectural decisions are recorded in docs/adr. Accepted decisions describe the intended design, not necessarily implemented features.
Siglus applies an unofficial Unicode cell-spacing extension automatically. It requires no configuration file or activation step on any host.
The extension uses Unicode widths rather than a language whitelist. It handles accented alphabetic text, font-measured Greek and Cyrillic, wide CJK, East Asian ambiguous punctuation such as Japanese ellipses and dashes, and canonical composition of decomposed characters in display runs. Newly handled alphabetic characters use their resolved font advances, including fallback fonts, so wide glyphs are not forced into overlapping half cells. Messages, names, ruby, text objects, choices, backlog, reconstructed choices, and editbox geometry share the policy. Editbox movement and deletion use grapheme boundaries. Script strings and native UTF-16/width commands retain their original semantics. Existing positioned save glyphs retain their coordinates.
This is the cell-spacing stage of ADR 0001, not complete Unicode typography. Contextual shaping, bidi, Unicode word/line breaking, complex mark attachment, joined emoji, cluster-aware font fallback, and lossless save reconstruction for future shaped layouts are still pending. Font availability still determines glyph coverage.
1993–1997 · AyPio
![]() Sorcer Kingdom Title screen. |
![]() Sorcer Kingdom Dialogue scene. |
![]() Sorcer Kingdom Map exploration. |
1996–2001 · VisualArt's
![]() AIR The title of AIR. |
![]() AIR Air opening. |
![]() Kanon Kanon opening. |
2001–2022 · VisualArt's
2010–now · VisualArt's
![]() macOS SiglusEngine running natively on macOS. |
![]() iOS SiglusEngine running on iOS. |
![]() WebAssembly SiglusEngine running in a web browser. |
![]() PS Vita Summer Pockets REFLECTION BLUE for PS Vita. |
![]() Nintendo Switch Anemoi for Nintendo Switch. |
- siglus_rs works on a wide range of platforms, including Windows, Linux, macOS, iOS, Android, and WebAssembly.
| Platform | Targets |
|---|---|
| Linux | x86_64, aarch64 |
| FreeBSD | x86_64 |
| Windows | x86_64, ARM64 |
| macOS | aarch64 app, x86_64 app, universal DMG app bundle |
| iOS | arm64 device, arm64 simulator, x86_64 simulator |
| Android | arm64-v8a, x86_64 |
| WebAssembly | wasm32-unknown-unknown |
| PS Vita | armv7 |
| Nintendo Switch | aarch64 |
The app launchers (macOS bundle, iOS, Android, WebAssembly) import one game or many games at once, detect the engine (SiglusEngine, RealLive, AVG32, UK2), show cover art or the game icon, and let you pick the text encoding for non-Siglus games. See crates/game_launcher.
- See preview releases on GitHub Releases
Android APKs from non-fork pushes and all tag builds use a persistent signing
key. The build aligns the APK, signs it, and verifies its signature before
uploading the siglus-android artifact.
Repository secrets ANDROID_KEY_BASE64 (base64-encoded keystore),
ANDROID_KEY_ALIAS, ANDROID_KEY_PASSWORD, and ANDROID_KEYSTORE_PASSWORD are
required. Missing signing configuration fails the Android job. Keep the same
key for future releases so installed apps can be updated.
Pull requests and branch pushes in forks only check compilation. They upload
siglus-android-unsigned/app-release-unsigned.apk, which is not directly
installable and is never published as a release or rolling pre-release. No
release signing secrets are required for these checks. Forks that publish
tagged releases must configure their own persistent signing key and secrets.
- API documentation is available at docs
- PS Vita port — experimental SiglusEngine player (
siglus-psvita.vpkon the releases page); installing it and a game is described there. Roadmap.
cargo run --release -p siglus_scene_vm --bin siglus_engine -- --project-dir ~/Documents/siglus_rs-main/testcaseClosing the desktop game window prefers the game's own exit confirmation.
The engine looks for a unique, parameterless exit action in shared script
commands, the configured cancel-menu scene, and the active title menu's local
button actions. Title actions are available only after the title buttons are
ready. Scripts that require EXCALL menu storage, unsupported or ambiguous
scripts, and already active system menus use the built-in confirmation instead.
An optional #CLOSE_SCENE = "scene_name", label entry in Gameexe.ini overrides
discovery: that scene must handle confirmation and call syscom.end_game on
acceptance; returning resumes the game.
Desktop windows use icon.png, icon.ico, or the first readable .ico file
(in filename order) from the game directory, falling back to the Siglus icon.
The engine uses winit 0.31.0-beta.3 to send window icons directly through
xdg_toplevel_icon_v1 on Wayland compositors that support it. No desktop entry
is generated. Each game retains a separate Wayland application ID.
If you want to join the development and discussion of this project, you can join the following Discord server:
- Discord: https://discord.gg/g4rXucPZz3
- Personally, I only able to speak English, Chinese, Japanese, and very limited French.
The key.toml file is used to specify different configuration options for siglus_rs. The file should be placed in the root directory of the game project.
-
This configuration key for this element is
key. It is an array of 16 bytes (128 bits) that represents the secondary key. -
SiglusEngine games require a secondary key to decrypt protected resources.
siglus_rs can automatically brute-force the secondary key, but if you want specify the key manually, you can create a key.toml file in the game root directory.
There are several practical ways to obtain the key:
-
Static extraction, when the game executable is not encrypted or obfuscated (recommended). The general idea can be found in this repository:
-
Dynamic extraction. The general idea can be found in this older repository:
-
Known-key databases maintained by some extractor tools.
Brute-force will be attempted in the following situations:
- If the key is not specified in the
key.tomlfile, siglus_rs will try to brute-force the key. - Users specify a wrong key in the
key.tomlfile. siglus_rs will try to override the key. - If siglus_rs fails to save or overwrite the
key.tomlfile, the engine will still execute.
Trial games may not require a secondary key, and in that case, you can specify all-zero key in the key.toml file. Here is an example of key.toml:
key = [
0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00,
]- This configuration key for this element is
override_string_encryption. The value of this key can bexor,none, ormdl. The default value isxor. - In very earlier versions of SiglusEngine, string encryption was not used.
- However, in later versions (for the most cases), string encryption is enabled by default.
Explanation of each value:
xor: Enbales the string encryption. This is the default value even if theoverride_string_encryptionkey is not specified in thekey.tomlfile.none: Disables the string encryption. If you are sure that the game does not use string encryption.mdl: Automatically detects the string encryption method by using the MDL approach (also see the paper: https://arxiv.org/abs/cs/0312044). It does introduce a performance overhead, but IMO, it's minor.
This project belongs to CrySirror project, which is a unified engine backend for visual novels and 3D games.
-
Bug fixes and improvements for the siglus engine is acceptable in this repository.
-
If you want to support a new platform (e.g. game console), please create an issue or pull request in the
CrySirrorrepository instead of this one.
This project is licensed under the MPL-2.0 License. See LICENSE for details.
















