Skip to content

Commit

Permalink
docs: 完善 配置-牌堆 一节 (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustAnotherID authored Oct 24, 2023
1 parent bb875a5 commit 797fb2c
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 24 deletions.
95 changes: 71 additions & 24 deletions docs/config/deck.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,89 @@ title: 牌堆

::: info 本节内容

本节将介绍牌堆,请善用侧边栏和搜索,按需阅读文档。
本节将介绍牌堆功能,请善用侧边栏和搜索,按需阅读文档。

:::

## 牌堆
## 牌堆是什么?

仓库:https://github.com/sealdice/draw
「牌堆」是一组有名字的文本,你可以把它想象成一组扑克牌,通过 `.draw` 命令来随机抽取其中的内容发送。为了便于骰子读取增加相应的说明内容,牌堆以某种结构化的格式保存成文件。

### 牌堆是什么 怎么加在骰子里
::: tip 牌堆

牌堆的本质是json文件或者yaml文件,编写遵循两者的语法
牌堆以 `json` `yaml``toml` 格式组织起来,但其本质只是一段文本,只是编写需要遵循对应的结构方便读取

- 一般的牌堆文件放置在.\data\decks 目录下以单独的文件存在,如果要添加
牌堆,你只需要把下载好的文件放在该目录下,然后对骰子发送 .draw
reload 指令就可以了。
:::

- 对于带图的牌堆压缩包,如果是按照seal格式来的,解压后整个文件夹拖进
decks目录里。
其他情况下的带图的牌堆文件压缩包一般会给一个说明
这里只给出几个大概的名词间等价关系 请自行摸索
## 获取牌堆

你可以在 [牌堆仓库](https://github.com/sealdice/draw) 或官方群的群文件中找到其他骰主分享的牌堆。

::: note 无法访问仓库?

仓库位于 Github,访问时请确认你的网络状况。

:::

## 怎么上传牌堆到骰子?怎么管理牌堆?

点击海豹 UI 界面的「扩展功能-牌堆管理」选项,你就可以进入牌堆的管理页面。

![牌堆管理](./images/deck-ui.png)

可以看见有一个「上传牌堆」按钮,点击它选择本地的牌堆文件上传后即可读取牌堆。

在上图中已经有一个名为「常规抽取与放回抽取示例」牌堆被读取到了,它的版本号是 1.1,格式是 `json`,其他信息也相应展示。

你可以通过「删除」按钮来删掉对应的牌堆。

::: tip 重载牌堆

新增/删除牌堆通常会自动重载,但如果出现牌堆未更新等情况时,可以手动点击「重载牌堆」按钮进行刷新。

:::

## 怎么使用牌堆?

在上面的「常规抽取与放回抽取示例」中,我们可以看见有名为 `常规抽取` `放回抽取` 的两个牌组。可以使用 `.draw` 命令来抽取它们。

```text
.draw 常规抽取
.draw 放回抽取
```
dicedata ≈ dice123456789 ≈ dice骰子QQ ≈ cocdata ≈ seal根目录
PublicDeck ≈ draw ≈ decks
mod ≈ helpdoc
pictures ≈ images
Q:.\data\decks 是什么?
A:在我的电脑上就是 D:\Uso\tmp\sealdice-core\data\decks 因为
D:\Uso\tmp\sealdice-core 和每个人解压seal程序的位置有关,是可以自定义的,
所以用 . 来表示
```

### 牌堆怎么用
更多牌堆命令,见 [使用-扩展:牌堆 自定义回复](../use/deck_and_reply.md)

## 牌堆更新与云牌堆

在加载某些牌堆之后,你可能会发现一些牌堆拥有特殊的功能:

![带有更新和云内容的牌堆示例](./images/deck-new-features.png)

### 牌堆更新

一些牌堆作者为牌堆提供了更新链接,方便你快速获取最新的牌堆内容。

点击「更新」按钮后会取获取最新的牌堆,随后弹出获取到的新牌堆与当前牌堆的对比:

![牌堆对比](./images/deck-diff.png =65%x65%)

[使用-扩展:牌堆 自定义回复](../use/deck_and_reply.md)
对比弹窗的右上角可以控制显示的样式,如勾选「折叠无变更」可以收起过长的内容。

确认牌堆的更新内容之后,点击「确认更新」即可升级到最新的牌堆。

### 牌堆云端内容

一些牌堆作者为牌堆提供了云端内容,这意味着这个牌堆在抽取时,可能会去拉取远程内容作为牌堆项。

所有含有云端内容的牌堆,海豹 UI 都会给出「提供云端内容」的提示。

::: warning 云端内容

牌堆作者可以实时调整云端内容,可能存在风险,请自行考虑是否使用这样的牌堆。

:::

### 牌堆怎么编写
## 牌堆怎么编写

[进阶-编写牌堆](../advanced/edit_deck.md)
Binary file added docs/config/images/deck-diff.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/config/images/deck-new-features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/config/images/deck-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/config/reply.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,12 @@ title: 自定义回复

在回复项的左上角可以控制该项的启用与否,右上角可以删除这一条回复项。当回复项较多的时候,可以点击「收缩」来将不重要的项折叠起来。

::: tip 随时保存修改

记得随时保存自己的修改,防止改动内容丢失。

:::

### 回复项的条件

在回复项的左上角是该项的匹配模式,可以理解为当什么情况下会触发这一条回复项。目前提供了三种匹配模式:
Expand Down

0 comments on commit 797fb2c

Please sign in to comment.