Skip to main content

AliceADV

aliceADV is a web-based ADV (visual novel) game engine that makes it easy to build high-performance visual novel games.

Developer-friendly. Scripts are a flat JSON instruction stream (segments of instructions) and the interface is described by a single theme.json, so a complete game needs no Python or CSS. That is a convenience, not a limitation: the title, save, load, settings, chapters, branches, gallery, and about pages are all there, and transitions, NVL, autosave, skip, and key mapping are fully implemented.

Easy to publish. A build produces plain static web files that can be deployed anywhere — native installers for each platform are on the way — so putting them on a free static host such as GitHub Pages is enough to let others play it online. The web build also ships with a preloading system that keeps the experience as good as it can be on a slow or unreliable network.

Partially compatible with Ren'Py. Asset directories (gui/, images/bg/, images/char/<id>/, audio/, including the button/ and overlay/ subdirectories), sprite positions, and common presentation semantics are compatible with Ren'Py projects, so existing assets can be carried over as they are; aliceadv rpy2adv converts .rpy scripts and aliceadv gui2theme converts gui.rpy layout into this engine's script and configuration.

Friendly to AI-assisted development. Have an idea for the galgame or otome text game you never had the skills to build? This package ships the documentation and the helper scripts, so you can hand it to an AI agent and let it learn the engine — you describe the game you want, and it turns that into something you can actually run.

The engine ships as a Python package providing a create / build command-line tool, plus the engine template (HTML/CSS/JS) that is assembled into each project at build time. A graphical development tool is on the way.

中文说明见仓库根目录 README_zh-CN.md。

Installation

Requires Python >= 3.6 (see requires-python in pyproject.toml).

pip install aliceadv

Prebuilt wheels are attached to the GitHub releases; you can download one and install it directly.

Quick start

# 1. Create a project (copies the engine template into a new directory)
aliceadv create my_game --name "My Game"

# 2. Edit theme.json (styling) and story/*.json (script)

# 3. Build → <project>/dist/web/
aliceadv build my_game

# 4. Play: open my_game/dist/web/index.html, or serve it
python3 -m http.server -d my_game/dist/web 8000

Game version & engine version

The game version comes from your project's info.json (version field, authored by you). The engine version is stamped by the packaged engine itself at build time and injected into the built index.html as window.__ENGINE__. Both are shown on the title page and the About page after a build — so you no longer maintain the engine version by hand.

Both numbers are zero-maintenance because they come from one place. The package version is written exactly once, in src/aliceadv/_version.py; __init__.py derives ENGINE_NAME / ENGINE_VERSION from it, and pyproject.toml reads the same value via [tool.setuptools.dynamic]:

Where How it gets the version
pyproject.toml ([project]) dynamic = ["version"] → [tool.setuptools.dynamic] version = { attr = "aliceadv._version.__version__" }
aliceadv/__init__.py from ._version import __version__;ENGINE_VERSION = "v" + __version__
Build output index.html window.__ENGINE__ = {"name": "aliceADV", "version": "vX.Y.Z"}
aliceadv --version aliceADV X.Y.Z (engine vX.Y.Z)

To cut a new version, edit that one line — nothing else in the repository carries a version number.

test_version.py guards the invariant so it cannot decay: it fails if a version literal reappears elsewhere, if pyproject.toml stops using dynamic, or if __init__.py stops deriving ENGINE_VERSION.

python tests/test_version.py

Command-line reference

Command Purpose
aliceadv create <dir> [--name NAME] [--force] Create a project by copying the engine template.
aliceadv build <dir> Build a project into <dir>/dist/web/.
aliceadv rpy2adv <script.rpy> <images_dir> <out_dir> Convert a Ren'Py script into story/ JSON.
aliceadv gui2theme <gui.rpy> <theme.json> [--apply] Convert Ren'Py gui.rpy layout into theme.json.

The build command refuses to run against the engine template directory itself (it contains the .aliceadv_engine marker). The engine runtime (index.html, style/) is not stored in your project — it is assembled from the engine template on every build, so upgrading the engine takes effect by simply rebuilding.

Documentation

Documentation is not bundled with this package, and aliceadv create does not copy any docs into projects. It lives in the engine repository under docs/ and is published as a documentation site:

https://alice-drop.github.io/aliceADV/

It covers the instruction manual, the script JSON specification, the theme.json and info.json configuration manuals, the engine overview, and how aliceadv build works.

License

Released under the MIT License.

Metadata

Release files for aliceadv 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aliceadv 0.5.0
File Size Uploaded Provenance Actions
aliceadv-0.5.0.tar.gz 13.7 MB Without provenance Details for aliceadv-0.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aliceadv 0.5.0
File Interpreter ABI Platform Actions
aliceadv-0.5.0-py3-none-any.whl Python 3 none any Details for aliceadv-0.5.0-py3-none-any.whl

Total release size: 27.5 MB

Release files / aliceadv-0.5.0.tar.gz

Download URL aliceadv-0.5.0.tar.gz
Size 13.7 MB
Tags Source
SHA-256 checksum
How to use checksums
5f16ffde790488a1d82c9d0edc870835a4ddd0fa2d616aa99b3f8575f7f1adc2
BLAKE2b-256 checksum
How to use checksums
0238b3341f0314bbeb1b7c8641c8b0b16ffe31f0c4da60102b31ec2310efc7d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Release files / aliceadv-0.5.0-py3-none-any.whl

Download URL aliceadv-0.5.0-py3-none-any.whl
Size 13.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
850c36bd5a966086c3a71a0caac0ddec4fcb8580208c3e620ebbb380730a3910
BLAKE2b-256 checksum
How to use checksums
05f3dd7b3ebe476b402836cfcadb5c77c550164608f0594784a34ec505485b88
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.5

Security for aliceadv 0.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page