Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: cookbook link fix and init translation #69

Merged
merged 5 commits into from
Dec 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Ayaka is currently a project for [OSPP 2022](https://summer-ospp.ac.cn/).

For Simplified Chinese version README, see [简体中文](https://github.com/Uni-Gal/Ayaka/blob/master/README_zh-Hans.md)

## About the name
The frontend is Ayaka. The runtime is Ayaka. The script is Ayaka. [Just Ayaka.](https://bbs.mihoyo.com/ys/article/21828380)

Expand All @@ -19,7 +21,7 @@ The frontend is Ayaka. The runtime is Ayaka. The script is Ayaka. [Just Ayaka.](
* A prototype LaTeX frontend to generate PDF from the config.

## Docs
For authors with little experience of programming, see [Ayaka cookbook](https://github.com/Uni-Gal/Ayaka-cookbook).
For authors with little experience of programming, see [Ayaka cookbook](https://github.com/Uni-Gal/Ayaka/tree/master/book/cookbook).

For developers, see [Ayaka Book](https://uni-gal.github.io/Ayaka/).

Expand Down
36 changes: 36 additions & 0 deletions README_zh-Hans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<img width=100 src="assets/logo.png"/>

# Ayaka

Ayaka目前是[OSPP 2022](https://summer-ospp.ac.cn/)的一个项目。

## 关于名字
前端是Ayaka。运行时是Ayaka。脚本是Ayaka。[Just Ayaka.](https://bbs.mihoyo.com/ys/article/21828380)

## 目前已完成的
* 使用Rust完成的跨平台视觉小说引擎。
Berrysoft marked this conversation as resolved.
Show resolved Hide resolved
* 基于YAML的定义明确且易于创作的视觉小说配置文件格式。
* 嵌入式的自定义脚本。
* 基于[CLDR](https://github.com/unicode-org/cldr) i18n支持。
* 基于[WebAssembly](https://webassembly.org/) 的一个灵活的插件系统。它通过脚本提供运行时和互操作功能的钩子。
* 一个“解耦合”的框架——前端、后端以及插件互相解耦合。
* 用于检查语法错误和快速调试的CLI前端。
* 基于[Tauri](https://tauri.app/)与[Vue](https://vuejs.org/)的GUI前端,并包含[Live2D](https://www.live2d.com)支持。
* 从配置直接生成PDF的LaTeX前端原型。

## 文档
对于不够擅长编程的创作者,可见[Ayaka cookbook](https://github.com/Uni-Gal/Ayaka/tree/master/book/cookbook).

对于开发者,可见[Ayaka Book](https://uni-gal.github.io/Ayaka/).

API文档需要在`utils/target/doc`内构建:
``` bash
$ make doc
```

## 运行截屏
![奥尔加](assets/galgui.png)

## 许可证

项目依[MIT license](LICENSE)许可。
22 changes: 22 additions & 0 deletions book/src_zh-Hans/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Summary

- [介绍](./intro.md)
- [快速开始](./quick_start.md)
- [配置](./config/summary.md)
- [文件结构](./config/structure.md)
- [指定角色](./config/character.md)
- [资源](./config/resources.md)
- [国际化](./config/i18n.md)
- [分支](./config/switches.md)
- [脚本](./config/script.md)
- [运行时](./runtime/summary.md)
- [运行一个游戏](./runtime/run.md)
- [插件](./plugin/summary.md)
- [Script 插件](./plugin/script_plugin.md)
- [Text 插件](./plugin/text_plugin.md)
- [Line 插件](./plugin/line_plugin.md)
- [Action 插件](./plugin/action_plugin.md)
- [Game 插件](./plugin/game_plugin.md)
- [GUI](./gui/summary.md)
- [Live2D](./gui/live2d.md)
- [支持的平台](./platforms.md)
50 changes: 50 additions & 0 deletions book/src_zh-Hans/quick_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 快速开始

## 先决条件
所有平台都需要安装有[Rust](https://www.rust-lang.org/)和[Nodejs](https://nodejs.org/)。
* Rust: nightly toolchain.
* Nodejs: [Vite](https://vitejs.dev/)需要14.18+/16+。

### Windows
建议使用Windows 10+,但Rust支持的任何Windows版本皆可。

[Tauri](https://tauri.app/)需要[WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/)。最新的Edge浏览器已包含它。

要运行Makefile工具链,您需要来自[MSYS2](https://www.msys2.org/)项目的GNU Make,Msys2(`make`)或Mingw64(`mingw32-make`)皆可。

请注意,如果在您的PATH中来自WSL的`bash.exe`位于MSYS2之前,则`npm`命令可能会失败。

### Linux
需要`webkit2gtk`。我们仅支持[Tauri](https://tauri.app/)锁依赖的`webkit2gtk-4.0`。

### macOS
通常我们不需要更多依赖,但你应该确保至少有`make`。

## 从源代码Clone
``` bash
$ git clone https://github.com/Uni-Gal/Ayaka.git
$ cd Ayaka
```

## 为WebAssembly添加target
``` bash
$ rustup target add wasm32-unknown-unknown
```

## 进行基础测试
``` bash
$ make test
```

## 运行实例
``` bash
$ # Run Fibonacci2
$ make example-Fibonacci2
$ # Run Orga in GUI
$ make example-Orga-gui
```

## 构建前端
``` bash
$ make release
```