Our visual novel engine with Rust!

[Berrysoft]

We finally named this project Ayaka today. It is such an important day, because we finally stopped calling it gal.

About this project

Ayaka is currently a project for OSPP 2022. According to the rules, we should show our work with a merged PR. Here is all our work recently. Contributions are welcomed after this PR is merged.

About the name

The frontend is Ayaka. The runtime is Ayaka. The script is Ayaka. Just Ayaka.

What we've done

• A cross-platform visual noval (VN) runtime with rust
• A well-defined and easy-to-author VN config file format, based on YAML.
• An embedded custom script.
• CLDR-based i18n support.
• A flexible plugin system based on WebAssembly. It provides hooks of the runtime and interop functionalities with the script.
• A decoupled framework - the frontend, backend and plugins are decoupled.
• A CLI frontend to check grammar errors and debug quickly.
• A GUI frontend powered by Tauri and Vue.
• A proto LaTeX frontend to generate PDF from the config.

Non-goal byproducts

• stream-future, a helper crate, separated from this repo.
• A language matcher based on CLDR data in Rust. We need it to reduce the ICU dependency.

What we need to do before merging

• Rename gal- to ayaka-. Rename gal binary to ayaka-check.
• Separate fallback and locale out.
• Draw a new logo. We should not infringe the copyright of miHoYo/HoYoVerse, but we all love Ayaka.
• Organize the docs, the book and the README.
• Archive the old repo.
• Write reports.

What we will do after merging

• Enable github actions & dependabot.
• Copy opened issues from the old repo.
• Publish the SDK to crates.io.
• Make some advertisements?
• Write some GalGame.

[Akarinnnnn]

希望在readme.md里展示脚本系统（脚本基本概念、示例、语法概要等）

[Berrysoft]

写在了 Ayaka Book 里面

[KireinaHoro]

Thanks a lot for the hard work!

LGTM in general. One quick suggestion would be that we could add a "powered by Ayaka" (or something similar) somewhere, for example the title page. This should be of course configurable and able to be turned off in config.yaml. The idea IMO could serve as a promotion to the framework, so that we get better adoption.