Skip to content

Commit 356f4b3

Browse files
BIYUEHUBIYUEHU
committed
docs: add .mrs highligh
1 parent 70af0d0 commit 356f4b3

File tree

4 files changed

+119
-10
lines changed

4 files changed

+119
-10
lines changed

‎README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
packages//misakura//README.md
1+
# AvgJS | Misakura
2+
3+
<!-- markdownlint-disable -->
4+
<div align="center">
5+
6+
[![wakatime](https://wakatime.com/badge/user/018dc603-712a-4205-a226-d4c9ccd0d02b/project/018e02fd-86e0-4f1e-9af9-61d0b70582b6.svg)](https://wakatime.com/badge/user/018dc603-712a-4205-a226-d4c9ccd0d02b/project/018e02fd-86e0-4f1e-9af9-61d0b70582b6)
7+
8+
<img src="https://raw.githubusercontent.com/BIYUEHU/misakura/master/packages/view/src-tauri/icons/misakura.png" width="200px" height="200px" alt="logo"/>
9+
10+
🌸 Next generation lightweight visual novel/Galgame game production engine 🌸
11+
12+
</div>
13+
<!-- markdownlint-enable -->
14+
15+
> Stack: Rust + Tauri + Solid.js + TypeScript
16+
17+
More information please visit [avg.js.org](https://avg.js.org).
18+
19+
- [Demo](https://avg.js.org/guide/demo.html)
20+
21+
## Declaration
22+
23+
1. We only welcome to **Japanese** visual novels and galgame, don't accept any non-Japanese visual novels maker or producer in this project and especially the Zhinese .
24+
2. **japanese visual novels maker and producer** don't represent you must be a Japanese person, but represent you can only create and make japanese visual novels and galgame. Nobody likes to see ugly someone (Zhinaman) make the visual novels base on elements of his country and said "国 GAL 崛起 (Zhinese visual novels are rising)". That behaviors must be rejected because it makes people feel uncomfortable and disgusting, and orthodox Japanese culture must be respected.
25+
26+
## Pictures
27+
28+
![1](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f33282533292a332a2a78252b297d2478257f2f2c2b7e2b792525782825292a326c727b.png)
29+
![2](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f33282b337829332a2a78252b297d2478257f2f2c2b7e2b79252578282b7829326c727b.png)
30+
![3](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f33287e33792d332a2a78252b297d2578257f2f2c2b7e2b79252578287e792d326c727b.png)
31+
![4](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f332425332525332a2a78252b297e7978257f2f2c2b7e2b7925257824252525326c727b.png)
32+
![5](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f33242533782e332a2a78252b297e7978257f2f2c2b7e2b792525782425782e326c727b.png)
33+
![6](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f33242433792a332a2a78252b297e7878257f2f2c2b7e2b792525782424792a326c727b.png)
34+
![7](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f33287d33247a332a2a78252b297d2478257f2f2c2b7e2b79252578287d247a326c727b.png)
35+
![8](https://files.superbed.cn/proxy/7468686c6f2633337a7570796f326f696c796e7e7978327f72336f68736e793375717d7b796f33282a332d2f332a2a78252b297d2b78257f2f2c2b7e2b79252578282a2d2f326c727b.png)

‎docs/.vitepress/cache/deps/_metadata.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
{
2-
"hash": "53e02bf5",
3-
"configHash": "3efb2b57",
2+
"hash": "ec8e31e1",
3+
"configHash": "ea886d30",
44
"lockfileHash": "e9749797",
5-
"browserHash": "b75ffca4",
5+
"browserHash": "f2a16d5b",
66
"optimized": {
77
"vue": {
88
"src": "../../../../node_modules/.pnpm/vue@3.4.31_typescript@5.5.4/node_modules/vue/dist/vue.runtime.esm-bundler.js",
99
"file": "vue.js",
10-
"fileHash": "349624e0",
10+
"fileHash": "c4c0ede5",
1111
"needsInterop": false
1212
},
1313
"vitepress > @vue/devtools-api": {
1414
"src": "../../../../node_modules/.pnpm/@vue+devtools-api@7.3.8/node_modules/@vue/devtools-api/dist/index.js",
1515
"file": "vitepress___@vue_devtools-api.js",
16-
"fileHash": "0590f7cf",
16+
"fileHash": "7586fef6",
1717
"needsInterop": false
1818
},
1919
"vitepress > @vueuse/core": {
2020
"src": "../../../../node_modules/.pnpm/@vueuse+core@11.0.0_vue@3.4.38_typescript@5.5.4_/node_modules/@vueuse/core/index.mjs",
2121
"file": "vitepress___@vueuse_core.js",
22-
"fileHash": "926d47d5",
22+
"fileHash": "2a1de451",
2323
"needsInterop": false
2424
}
2525
},

‎docs/.vitepress/config.ts

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
import { defineConfig } from 'vitepress'
22
import navbar from './config/navbar'
33
import sidebar from './config/sidebar'
4+
import misakurarustscript from '../../extension/syntaxes/mrs.tmLanguage.json'
5+
46

57
export default defineConfig({
68
srcDir: 'src',
@@ -24,8 +26,21 @@ export default defineConfig({
2426
sidebar: sidebar,
2527
socialLinks: [{ icon: 'github', link: 'https://github.com/biyuehu/misakura' }],
2628
footer: {
27-
copyright: 'MIT Licensed | Copyright © 2024 Hotaru'
29+
copyright: '<a target="_blank" href="https://github.com/iceagenb/ban-zhinese-using/blob/main/LICENSE.md">BCU Licensed</a> | Copyright © 2024 - 2025 Hotaru'
2830
}
2931
},
30-
lastUpdated: true
32+
lastUpdated: true,
33+
markdown: {
34+
theme: {
35+
light: 'vitesse-light',
36+
dark: 'vitesse-dark'
37+
},
38+
languages: [
39+
{
40+
// biome-ignore lint:
41+
...(misakurarustscript as any),
42+
aliases: ['misakura',]
43+
}
44+
]
45+
}
3146
})

‎docs/src/guide/setup.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,64 @@ fn main() {
109109

110110
**public/scripts/main.mrs**:
111111

112-
![script](https://pic.imgdb.cn/item/65f832d29f345e8d0328d459.png)
112+
```mrs
113+
# Main.mrs - Misakura 脚本默认入口文件
114+
115+
# 加载 i18n 国际化文件
116+
# using /locales/ --global
117+
118+
# 加载背景
119+
background /images/background/1.png
120+
121+
# 加载角色
122+
character neri --name '角色名字' --figure /images/figure/neri.png
123+
# Options:
124+
# -N, --name 设置角色显示名字
125+
# -F, --figure 设置角色当前使用立绘
126+
# -V, --voice 设置角色语音文件
127+
128+
# 对话
129+
# 无说话者消息（角色独白），阻塞指令（将暂停程序直至用户点击屏幕）
130+
say '这是一串非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常长的文本'
131+
# 有说话者消息
132+
say 'hi' -S neri
133+
# Options:
134+
# -S, --speaker 设置该消息的说话者
135+
136+
play /audio/music/1.flac
137+
# 播放背景音乐（循环播放）
138+
139+
# 显示角色立绘
140+
show neri
141+
142+
neri: 这是一个对话测试
143+
# say 指令语法糖, 等同于 say '这是一个对话测试' -S neri
144+
neri: 这也是一个对话测试
145+
: 又是一个段落
146+
# 当上文有设置 speaker 时，下文可无需再次设置 speaker
147+
# 此处的speaker为上面的neri，适当的使用这种语法糖对于脚本的简化是非常重要的
148+
149+
think: 自带的 character ID：⌈think⌋，代表角色独白
150+
think: 适当的在游戏使用独白内容可展示当前角色的心理活动
151+
think: 至于角色独白到底是哪个角色的心理活动，并不需要明确在脚本中指代，这取决于剧情上下文（也就是编写脚本的你决定）
152+
think: 同时，一句话不应太过长。
153+
unknown: 自带的 character ID：⌈unknown⌋，代表未知角色
154+
: "这里有一些需使用转义 \\ 符号才可表示的英文符号：\" \', 因为这些符号已经用在了 Misakura 脚本中，如若不转义将会导致脚本语法错误"
155+
156+
157+
# 切换背景
158+
background /images/background/2.png
159+
show neri
160+
# 切换背景后会清除之前所有显示的角色，因此如果要展示角色的话需再次使用 show 指令
161+
neri: 又出现了！
162+
character neri --figure /images/figure/neri_smile.png
163+
# 再次使用 character 附上相应参数会更新相关角色信息
164+
# 此处更新了角色立绘图片 使其为一个笑脸表情
165+
neri: bye~~
166+
167+
# 隐藏角色立绘
168+
show neri --hide
169+
170+
: 'ending...'
171+
172+
```

0 commit comments

Comments
 (0)