Our visual novel engine with Rust!

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+- package-ecosystem: cargo
+  directory: "/utils"
+  schedule:
+    interval: daily
+
+- package-ecosystem: cargo
+  directory: "/plugins"
+  schedule:
+    interval: daily
+
+- package-ecosystem: cargo
+  directory: "/bins"
+  schedule:
+    interval: daily

.github/workflows/release.yml

@@ -0,0 +1,51 @@
+name: Release
+on:
+  push:
+    branches: ["master"]
+jobs:
+  Build:
+    strategy:
+      matrix:
+        platform:
+          - name: linux-x64
+            os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            postfix:
+          - name: windows-x64
+            os: windows-latest
+            target: x86_64-pc-windows-msvc
+            postfix: .exe
+          - name: macos-x64
+            os: macos-latest
+            target: x86_64-apple-darwin
+            postfix:
+          - name: macos-arm64
+            os: macos-latest
+            target: aarch64-apple-darwin
+            postfix:
+    runs-on: ${{ matrix.platform.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: sudo apt-get install -y libwebkit2gtk-4.0-dev
+        if: matrix.platform.name == 'linux-x64'
+      - name: Install targets
+        run: |
+          rustup target add ${{ matrix.platform.target }}
+          rustup target add wasm32-unknown-unknown
+          rustup target add wasm32-wasi
+      - name: Build
+        run: make plugins release-cross TARGET=${{ matrix.platform.target }}
+      - name: Publish plugins
+        uses: actions/upload-artifact@v3
+        with:
+          name: plugins
+          path: examples/plugins/
+      - name: Publish binaries
+        uses: actions/upload-artifact@v3
+        with:
+          name: release-${{ matrix.platform.name }}
+          path: |
+            bins/target/${{ matrix.platform.target }}/release/ayaka-check${{ matrix.platform.postfix }}
+            bins/target/${{ matrix.platform.target }}/release/ayaka-gui${{ matrix.platform.postfix }}
+            bins/target/${{ matrix.platform.target }}/release/ayaka-latex${{ matrix.platform.postfix }}

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+jobs:
+  Test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: sudo apt-get install -y libwebkit2gtk-4.0-dev
+        if: matrix.os == 'ubuntu-latest'
+      - name: Install targets
+        run: |
+          rustup target add wasm32-unknown-unknown
+          rustup target add wasm32-wasi
+      - name: Test
+        run: make test

.gitignore

@@ -0,0 +1,9 @@
+**/target
+**/*.rs.bk
+.cargo
+Cargo.lock
+
+.vscode
+.cache
+.clangd
+.vs

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Berrysoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,51 @@
+.PHONY: test nextest clean update doc serve-book
+test: plugins
+	cd utils && $(MAKE) test
+nextest: plugins
+	cd utils && $(MAKE) nextest
+clean:
+	cd bins && $(MAKE) clean
+	cd utils && $(MAKE) clean
+	cd plugins && $(MAKE) clean
+	cd book && $(MAKE) clean
+update:
+	cd bins && $(MAKE) update
+	cd utils && $(MAKE) update
+	cd plugins && $(MAKE) update
+doc:
+	cd utils && $(MAKE) doc
+	cd book && $(MAKE) build
+serve-book:
+	cd book && $(MAKE) serve
+
+.PHONY: plugins release release-cross
+plugins:
+	cd plugins && $(MAKE) plugins
+release:
+	cd bins && $(MAKE) release
+release-cross:
+	cd bins && $(MAKE) release-cross TARGET=$(TARGET)
+
+EXAMPLES:=Fibonacci Fibonacci2 Gacha Live2D Orga Styles
+
+define example-tpl
+.PHONY: example-$(1) example-$(1)-gui example-$(1)-release example-$(1)-gui-release examples/$(1)/config.tex
+example-$(1): examples/$(1)/config.yaml plugins
+	cd bins && $$(MAKE) run FILE=$$(realpath $$<)
+example-$(1)-gui: examples/$(1)/config.yaml plugins
+	cd bins && $$(MAKE) run-gui FILE=$$(realpath $$<)
+example-$(1)-release: examples/$(1)/config.yaml plugins release
+	bins/target/release/ayaka-check $$< --auto
+example-$(1)-gui-release: examples/$(1)/config.yaml plugins release
+	bins/target/release/ayaka-gui $$<
+examples/$(1)/config.tex: examples/$(1)/config.yaml
+	cd bins && $$(MAKE) run-latex FILE=$$(realpath $$<)
+
+endef
+
+$(eval $(foreach ex,$(EXAMPLES),$(call example-tpl,$(ex))))
+
+%.pdf: %.tex
+	cd $(dir $<) && latexmk -lualatex $(notdir $<)
+
+.SECONDARY:

README.md

@@ -1,3 +1,33 @@
 # Ayaka
 
-This is the main repository of Ayaka, a visual novel engine written by Rust.
+Ayaka is currently a project for [OSPP 2022](https://summer-ospp.ac.cn/).
+
+## About the name
+The frontend is Ayaka. The runtime is Ayaka. The script is Ayaka. [Just Ayaka.](https://bbs.mihoyo.com/ys/article/21828380)
+
+## 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](https://github.com/unicode-org/cldr)-based i18n support.
+* A flexible plugin system based on [WebAssembly](https://webassembly.org/). 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](https://tauri.app/) and [Vue](https://vuejs.org/).
+* A proto LaTeX frontend to generate PDF from the config.
+
+## Docs
+See Ayaka Book:
+``` bash
+$ make serve-book
+```
+If you don't have `mdbook` installed, simply read the markdown files in `book` folder.
+To start quickly, follow the instructions in [Quick start](./book/src/quick_start.md).
+
+Build API docs into `utils/target/doc`:
+``` bash
+$ make doc
+```
+
+## Screenshot
+![Orga](assets/galgui.png)

bins/Cargo.toml

@@ -0,0 +1,12 @@
+[workspace]
+members = [
+    "ayaka-check",
+    "ayaka-gui/src-tauri",
+    "ayaka-latex",
+]
+
+resolver = "2"
+
+[profile.release]
+lto = true
+codegen-units = 1

bins/Makefile

@@ -0,0 +1,22 @@
+.PHONY: clean update
+clean:
+	cargo clean
+	cd ayaka-gui && $(MAKE) clean
+update:
+	cargo update
+
+.PHONY: dist release release-cross
+dist:
+	cd ayaka-gui && $(MAKE) dist
+release: dist
+	STATIC_VCRUNTIME=false cargo build --release
+release-cross: dist
+	STATIC_VCRUNTIME=false PKG_CONFIG_ALLOW_CROSS=1 cargo build --release --target=$(TARGET)
+
+.PHONY: run run-gui run-latex
+run:
+	RUST_LOG=info cargo run --package ayaka-check -- $(FILE) --auto
+run-gui:
+	cd ayaka-gui && $(MAKE) run FILE=$(FILE)
+run-latex:
+	RUST_LOG=info cargo run --package ayaka-latex -- $(FILE) -o $(basename $(FILE)).tex

bins/ayaka-check/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "ayaka-check"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+ayaka-runtime = { path = "../../utils/ayaka-runtime" }
+tokio = { version = "1", features = ["macros", "rt"] }
+clap = { version = "3.1", features = ["derive"] }
+env_logger = "0.9"

bins/ayaka-check/src/main.rs

@@ -0,0 +1,96 @@
+use ayaka_runtime::{
+    anyhow::{bail, Result},
+    log::LevelFilter,
+    *,
+};
+use clap::Parser;
+use std::{
+    ffi::OsString,
+    io::{stdin, stdout, Write},
+};
+
+#[derive(Debug, Parser)]
+#[clap(about, version, author)]
+pub struct Options {
+    input: OsString,
+    #[clap(long)]
+    check: bool,
+    #[clap(long)]
+    auto: bool,
+    #[clap(short, long)]
+    locale: Option<Locale>,
+}
+
+fn read_line() -> Result<String> {
+    stdout().flush()?;
+    let mut s = String::new();
+    stdin().read_line(&mut s)?;
+    Ok(s)
+}
+
+fn pause(auto: bool) -> Result<()> {
+    if auto {
+        println!();
+    } else {
+        read_line()?;
+    }
+    Ok(())
+}
+
+#[tokio::main(flavor = "current_thread")]
+async fn main() -> Result<()> {
+    let opts = Options::parse();
+    env_logger::Builder::from_default_env()
+        .filter_module("wasmer", LevelFilter::Warn)
+        .try_init()?;
+    let context = Context::open(&opts.input, FrontendType::Text);
+    pin_mut!(context);
+    while let Some(status) = context.next().await {
+        match status {
+            OpenStatus::LoadProfile => println!("Loading profile..."),
+            OpenStatus::CreateRuntime => println!("Creating runtime..."),
+            OpenStatus::LoadPlugin(name, i, len) => {
+                println!("Loading plugin {} ({}/{})", name, i + 1, len)
+            }
+        }
+    }
+    let mut ctx = context.await?;
+    if opts.check && !ctx.check() {
+        bail!("Check failed.");
+    }
+    ctx.init_new();
+    ctx.set_locale(opts.locale.unwrap_or_else(Locale::current));
+    while let Some(action) = ctx.next_run() {
+        if let Some(name) = &action.character {
+            print!("_{}_", name);
+        }
+        for s in action.line {
+            print!("{}", s.as_str());
+        }
+        if !action.switches.is_empty() {
+            for (i, s) in action.switches.iter().enumerate() {
+                if s.enabled {
+                    print!("\n-{}- {}", i + 1, s.text);
+                } else {
+                    print!("\n-x- {}", s.text);
+                }
+            }
+            println!();
+            loop {
+                let s = read_line()?;
+                if let Ok(i) = s.trim().parse::<usize>() {
+                    let valid =
+                        i > 0 && i <= action.switches.len() && action.switches[i - 1].enabled;
+                    if valid {
+                        ctx.call(&action.switches[i - 1].action);
+                        break;
+                    }
+                }
+                println!("Invalid switch, enter again!");
+            }
+        } else {
+            pause(opts.auto)?;
+        }
+    }
+    Ok(())
+}

bins/ayaka-gui/.gitignore

@@ -0,0 +1,29 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+package-lock.json
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?