Skip to content

Commit

Permalink
docs: add .mrs highligh
Browse files Browse the repository at this point in the history
  • Loading branch information
BIYUEHU committed Jan 24, 2025
1 parent 70af0d0 commit 356f4b3
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 10 deletions.
36 changes: 35 additions & 1 deletion README.md
12 changes: 6 additions & 6 deletions docs/.vitepress/cache/deps/_metadata.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
{
"hash": "53e02bf5",
"configHash": "3efb2b57",
"hash": "ec8e31e1",
"configHash": "ea886d30",
"lockfileHash": "e9749797",
"browserHash": "b75ffca4",
"browserHash": "f2a16d5b",
"optimized": {
"vue": {
"src": "../../../../node_modules/.pnpm/[email protected][email protected]/node_modules/vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "349624e0",
"fileHash": "c4c0ede5",
"needsInterop": false
},
"vitepress > @vue/devtools-api": {
"src": "../../../../node_modules/.pnpm/@[email protected]/node_modules/@vue/devtools-api/dist/index.js",
"file": "vitepress___@vue_devtools-api.js",
"fileHash": "0590f7cf",
"fileHash": "7586fef6",
"needsInterop": false
},
"vitepress > @vueuse/core": {
"src": "../../../../node_modules/.pnpm/@[email protected][email protected][email protected]_/node_modules/@vueuse/core/index.mjs",
"file": "vitepress___@vueuse_core.js",
"fileHash": "926d47d5",
"fileHash": "2a1de451",
"needsInterop": false
}
},
Expand Down
19 changes: 17 additions & 2 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { defineConfig } from 'vitepress'
import navbar from './config/navbar'
import sidebar from './config/sidebar'
import misakurarustscript from '../../extension/syntaxes/mrs.tmLanguage.json'


export default defineConfig({
srcDir: 'src',
Expand All @@ -24,8 +26,21 @@ export default defineConfig({
sidebar: sidebar,
socialLinks: [{ icon: 'github', link: 'https://github.com/biyuehu/misakura' }],
footer: {
copyright: 'MIT Licensed | Copyright © 2024 Hotaru'
copyright: '<a target="_blank" href="https://github.com/iceagenb/ban-zhinese-using/blob/main/LICENSE.md">BCU Licensed</a> | Copyright © 2024 - 2025 Hotaru'
}
},
lastUpdated: true
lastUpdated: true,
markdown: {
theme: {
light: 'vitesse-light',
dark: 'vitesse-dark'
},
languages: [
{
// biome-ignore lint:
...(misakurarustscript as any),
aliases: ['misakura',]
}
]
}
})
62 changes: 61 additions & 1 deletion docs/src/guide/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,64 @@ fn main() {

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

![script](https://pic.imgdb.cn/item/65f832d29f345e8d0328d459.png)
```mrs
# Main.mrs - Misakura 脚本默认入口文件
# 加载 i18n 国际化文件
# using /locales/ --global
# 加载背景
background /images/background/1.png
# 加载角色
character neri --name '角色名字' --figure /images/figure/neri.png
# Options:
# -N, --name 设置角色显示名字
# -F, --figure 设置角色当前使用立绘
# -V, --voice 设置角色语音文件
# 对话
# 无说话者消息(角色独白),阻塞指令(将暂停程序直至用户点击屏幕)
say '这是一串非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常非常长的文本'
# 有说话者消息
say 'hi' -S neri
# Options:
# -S, --speaker 设置该消息的说话者
play /audio/music/1.flac
# 播放背景音乐(循环播放)
# 显示角色立绘
show neri
neri: 这是一个对话测试
# say 指令语法糖, 等同于 say '这是一个对话测试' -S neri
neri: 这也是一个对话测试
: 又是一个段落
# 当上文有设置 speaker 时,下文可无需再次设置 speaker
# 此处的speaker为上面的neri,适当的使用这种语法糖对于脚本的简化是非常重要的
think: 自带的 character ID:⌈think⌋,代表角色独白
think: 适当的在游戏使用独白内容可展示当前角色的心理活动
think: 至于角色独白到底是哪个角色的心理活动,并不需要明确在脚本中指代,这取决于剧情上下文(也就是编写脚本的你决定)
think: 同时,一句话不应太过长。
unknown: 自带的 character ID:⌈unknown⌋,代表未知角色
: "这里有一些需使用转义 \\ 符号才可表示的英文符号:\" \', 因为这些符号已经用在了 Misakura 脚本中,如若不转义将会导致脚本语法错误"
# 切换背景
background /images/background/2.png
show neri
# 切换背景后会清除之前所有显示的角色,因此如果要展示角色的话需再次使用 show 指令
neri: 又出现了!
character neri --figure /images/figure/neri_smile.png
# 再次使用 character 附上相应参数会更新相关角色信息
# 此处更新了角色立绘图片 使其为一个笑脸表情
neri: bye~~
# 隐藏角色立绘
show neri --hide
: 'ending...'
```

0 comments on commit 356f4b3

Please sign in to comment.