📝 updated README

MinatoAquaCrews · Oct 22, 2023 · 726962f · 726962f
1 parent aada4ba
commit 726962f
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 24 deletions.
diff --git a/.github/workflows/poetry-publish.yml b/.github/workflows/poetry-publish.yml
@@ -29,5 +29,4 @@ jobs:
         with:
           python_version: "3.10"
           pypi_token: ${{ secrets.PYPI_API_TOKEN }}
-          build_format: "wheel"
           ignore_dev_requirements: "yes"
diff --git a/How-to-add-new-tarot-theme.md b/How-to-add-new-tarot-theme.md
@@ -4,21 +4,19 @@
 
 1. 该功能对**图片后缀无要求**
 
-2. 如果你有完整的塔罗牌资源，请根据[资源说明](./README.md#资源说明)与 `./resource/BilibiliTarot` 的目录结构将塔罗牌分类并**建立对应目录**，并**重命名**塔罗牌图片文件：
+2. 如果你有完整的塔罗牌资源，请根据[资源说明](./README.md#资源说明)与 `./resource/BilibiliTarot` 的目录结构将塔罗牌分类并**建立对应目录**，并**重命名**塔罗牌图片文件与其保持一致：
 
    ```python
    ["MajorArcana", "Cups", "Pentacles", "Sowrds", "Wands"]
    ```
 
-3. 如果塔罗牌资源不完整也没关系，但请确保**每个子类资源完整**。例如，我有新的塔罗牌主题 `NameOfNewTheme`，但仅有大阿卡纳22张，及圣杯15张，则建立如下 `NameOfNewTheme` 子目录：
+3. 如果塔罗牌资源不完整也没关系，但请确保**每个子类资源完整**。例如，我有新的塔罗牌主题 `NewTarotTheme`，但仅有大阿卡纳22张，及圣杯15张，则建立如下 `NewTarotTheme` 子目录：
 
    ```
    MyTarotResource
    ├ BilibiliTarot
    │ └ ……
-   ├ TouhouTarot
-   │ └ ……
-   └ NameOfNewTheme
+   └ NewTarotTheme
      ├ Cups
      │ ├ 圣杯-01.png
      │ ├ 圣杯-02.png
@@ -31,9 +29,9 @@
        └ 21-世界.png
    ```
 
-   将其放入 `TAROT_PATH` 目录下即可。例如，以上示例，**所有的塔罗牌资源**均在 `MyTarotResource` 目录下，则设置：
+   将其放入 `TAROT_PATH` 目录下即可。例如，上述示例中，**所有的塔罗牌资源**均在 `MyTarotResource` 目录下，则设置：
 
-   ```
+   ```toml
    TAROT_PATH="your-path-to-MyTarotResource"
    ```
 

diff --git a/README.md b/README.md
@@ -13,10 +13,10 @@ _🔮 塔罗牌 🔮_
   </a>
 
   <a href="https://github.com/nonebot/nonebot2">
-    <img src="https://img.shields.io/badge/nonebot2-2.0.0b3+-green">
+    <img src="https://img.shields.io/badge/nonebot2-2.0.0+-green">
   </a>
 
-  <a href="https://github.com/MinatoAquaCrews/nonebot_plugin_tarot/releases/tag/v0.4.0.post4">
+  <a href="https://github.com/MinatoAquaCrews/nonebot_plugin_tarot/releases/tag/v0.5.0a1">
     <img src="https://img.shields.io/github/v/release/MinatoAquaCrews/nonebot_plugin_tarot?color=orange">
   </a>
 
@@ -40,31 +40,71 @@ _“许多傻瓜对千奇百怪的迷信说法深信不疑：象牙、护身符
 
 ## 版本
 
-🧰 [v0.4.0.post4](https://github.com/MinatoAquaCrews/nonebot_plugin_tarot/releases/tag/v0.4.0.post4)
+🧰 [v0.5.0a1](https://github.com/MinatoAquaCrews/nonebot_plugin_tarot/releases/tag/v0.5.0a1)
 
-⚠ 适配nonebot2-2.0.0b3+
-
-👉 [如何添加新的塔罗牌主题资源？](./How-to-add-new-tarot-theme.md)欢迎贡献！🙏
+⚠ 适配nonebot2-2.0.0+
 
 ## 安装
 
-1. 通过 `pip` 或 `nb` 安装。pypi无法发行过大安装包，由此安装的插件不包含 `./resource` 下**所有塔罗牌主题资源**。请在[v0.4.0 release](https://github.com/MinatoAquaCrews/nonebot_plugin_tarot/releases/tag/v0.4.0)页面下载各主题资源，部署至本地后修改 `TAROT_PATH` 配置即可；
+1. 安装方式
+   - 通过 `pip` 或 `nb-cli` 安装。pypi无法发行过大安装包，由此安装的插件不包含 `./resource` 下提供的塔罗牌主题资源。仓库提供了两种塔罗牌主题，可在 [v0.4.0 release](https://github.com/MinatoAquaCrews/nonebot_plugin_tarot/releases/tag/v0.4.0) Assets下载，部署至本地后修改 `TAROT_PATH` 配置即可；
+
+   - 通过 `zip` 或 `git clone` 安装：包含 `resource` 下所有塔罗牌主题资源；
+
+2. `CHAIN_REPLY` 设置全局群聊转发模式（避免刷屏），可通过命令开启或关闭，默认开启；
 
-2. `env` 下设置 `TAROT_PATH` 以更改资源路径；`CHAIN_REPLY` 设置全局群聊转发模式（避免刷屏），亦可通过命令修改；`TAROT_AUTO_UPDATE` 开启则插件将在启动时自动检查更新（默认关闭）。例如：
+3. `env` 下设置 `TAROT_PATH` 以更改资源路径，该目录下存放各塔罗牌主题图片（子目录表示不同主题）。默认为 `nonebot_plugin_localstore` 为本插件提供的路径。例如：
 
-   ```python
-   TAROT_PATH="path-to-your-resource"
+   ```toml
+   TAROT_PATH="path-to-MyTarotResource"
    CHAIN_REPLY=false
-   TAROT_AUTO_UPDATE=false
    ```
 
-   ⚠ 请为塔罗牌资源分配单独的目录存放！即某一目录下仅有塔罗牌的所有资源。[#26](https://github.com/MinatoAquaCrews/nonebot_plugin_tarot/issues/26)
+   ```
+   MyTarotResource
+   ├ BilibiliTarot
+   │ └ ……
+   └ TouhouTarot
+     └ ……
+   ```
+
+4. 用户应启用**至少一种主题**。仓库提供了两种主题，但仅将 `BilibiliTarot` 作为插件**内置主题**（另一主题主题可选）。配置项 `TAROT_BUILTIN_THEME_ENABLED` 以启用（默认开启）内置主题。该配置项可配合 `TAROT_EXTRA_THEMES` 使用。
+
+   ```toml
+   # 错误！无可用主题！
+   TAROT_BUILTIN_THEME_ENABLED=false
+   TAROT_EXTRA_THEMES=[]
+
+   # 正确！仅使用插件内置主题BilibiliTarot
+   TAROT_BUILTIN_THEME_ENABLED=true
+   TAROT_EXTRA_THEMES=[]
 
-3. 启动时，插件会自动下载repo中最新的 `tarot.json` 文件，`tarot.json` 不一定随插件版本更新；
+   # 正确！仅使用用户提供的主题MyTarotTheme
+   TAROT_BUILTIN_THEME_ENABLED=false
+   TAROT_EXTRA_THEMES=["MyTarotTheme"]
 
-4. 图片资源可选择**不部署在本地**，插件会自动尝试从repo中下载缓存。
+   # 正确！使用插件内置主题BilibiliTarot与额外的主题TouhouTarot
+   TAROT_BUILTIN_THEME_ENABLED=true
+   TAROT_EXTRA_THEMES=["TouhouTarot"]
+   ```
+
+5. 图片资源可选择**不部署在本地**，此时，如果所需主题为仓库提供的两种主题之一，则会尝试下载并缓存。此外，用户也可以添加自己的塔罗牌主题。配置项 `TAROT_EXTRA_THEMES` 用以添加本地部署的自定义主题。例如，用户额外添加了两个主题，则对应目录结构为：
+
+   ```toml
+   TAROT_PATH="path-to-MyTarotResource"
+   TAROT_EXTRA_THEMES=["MyTarotTheme1", "MyTarotTheme2"]
+   ```
+   ```
+   MyTarotResource
+   ├ MyTarotTheme1
+   │ └ ……
+   └ MyTarotTheme2
+     └ ……
+   ```
 
-   ⚠ 使用 `raw.fgit.cf` 进行下载，不确保次次成功
+   ⚠ 使用 `raw.fgit.cf` 下载仓库提供的主题，不确保次次成功
+
+   👉 [如何添加新的塔罗牌主题资源？](./How-to-add-new-tarot-theme.md) 欢迎贡献！🙏
 
 ## 命令
 
@@ -83,7 +123,7 @@ _“许多傻瓜对千奇百怪的迷信说法深信不疑：象牙、护身符
 
    ⚠ 资源中额外四张王牌(Ace)不在体系中，因此不会在占卜时用到，因为小阿卡纳中各系均有Ace牌，但可以自行收藏。
 
-2. `tarot.json`中对牌阵，抽牌张数、是否有切牌、各牌正逆位解读进行说明。`cards` 字段下对所有塔罗牌做了正逆位含义与资源路径的说明；
+2. `tarot.json` 中对牌阵，抽牌张数、是否有切牌、各牌正逆位解读进行说明。`cards` 字段下对所有塔罗牌做了正逆位含义与资源路径的说明；
 
 3. 根据牌阵的不同有不同的塔罗牌解读，同时也与问卜者的问题、占卜者的解读等因素相关，因此不存在所谓的解读方式正确与否。`cards` 字段下的正逆位含义参考以下以及其他网络资源：