📖 更新文档 和 issue template

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,119 @@
+name: Bug 反馈
+description: 在使用插件的过程中遇到了错误
+title: "[Bug]: "
+
+body:
+  # User's README and agreement
+  - type: markdown
+    attributes:
+      value: |
+        ## 感谢您愿意填写 Bug 反馈！
+        ## 以下是一些注意事项，请务必阅读让我们能够更容易处理
+
+        ### ❗ | 确定没有相同问题的ISSUE已被提出. ([查找](https://github.com/GuGuMur/nonebot-plugin-skland-arksign/issues?q=is%3Aissue))
+        ### 🌎 | 请准确填写环境信息
+
+        ## 如果您不知道如何有效、精准地表述，我们建议您先阅读《提问的智慧》
+        链接: [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)
+        ---
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: 请确保您已阅读以上注意事项，并勾选下方的确认框。
+      options:
+        - label: "我已经仔细阅读插件的 README"
+          required: true
+        - label: "我的Python版本满足>= 3.10"
+          required: true
+        - label: "我已经将插件和机器人环境依赖都安装到了推荐/最新版本"
+          required: true
+        - label: "我确定指令输入并无错误"
+          required: true
+        - label: 我已知晓并同意，此处仅用于汇报程序中存在的问题。若这个 Issue 是关于其他非程序本身问题，则我的 Issue 可能会被无条件自动关闭或/并锁定。
+          required: true
+
+  # User's data
+  - type: markdown
+    attributes:
+      value: |
+        ## 环境信息
+        请根据实际使用环境修改以下信息。
+
+  # Env | VM Version
+  - type: dropdown
+    id: env-vm-ver
+    attributes:
+      label: 运行环境
+      description: 选择运行该插件的系统版本
+      options:
+        - Windows (64)
+        - Windows (32/x84)
+        - MacOS
+        - Linux
+        - Ubuntu
+        - CentOS
+        - ArchLinux
+        - 其它（请在下方说明）
+    validations:
+      required: true
+
+  # Env | VM Arch
+  - type: dropdown
+    id: env-nb2-ver
+    attributes:
+      label: Nonebot 2 版本
+      description: 选择运行机器人 Nonebot 2 的系统架构
+      options:
+        - 2.0.1
+        - 2.1.0
+        - 2.1.1
+        - 其它（请在下方说明）
+    validations:
+      required: true
+
+  # Input | Reproduce
+  - type: textarea
+    id: reproduce-steps
+    attributes:
+      label: 重现步骤
+      description: |
+        我们需要执行哪些操作才能让 bug 出现？
+        简洁清晰的重现步骤能够帮助我们更迅速地定位问题所在。
+    validations:
+      required: true
+
+  # Input | Expected result
+  - type: textarea
+    id: expected
+    attributes:
+      label: 期望的结果是什么？
+    validations:
+      required: true
+
+  # Input | Actual result
+  - type: textarea
+    id: actual
+    attributes:
+      label: 实际的结果是什么？
+    validations:
+      required: true
+
+  # Optional | Reproduce code
+  - type: textarea
+    id: reproduce-code
+    attributes:
+      label: 简单的复现代码/链接（可选）
+      render: python
+
+  # Optional | Logging
+  - type: textarea
+    id: logging
+    attributes:
+      label: 日志记录（可选）
+      render: python
+
+  # Optional | Extra description
+  - type: textarea
+    id: extra-desc
+    attributes:
+      label: 补充说明（可选）

README.md

@@ -81,8 +81,10 @@ plugins = ["nonebot_plugin_skland_arksign"]
 </details>
 
 > [!IMPORTANT]
-> 如果想在 **Python <= 3.9** 的环境中使用，请选择 `v0.5.8`，这是最后一个支持 **Python <= 3.9** 的 Release  
-> ~严格来说其实是第一个以及最后一个，因为之前的版本有不适用于**非3.10以下**的类型注解语法，为此专门发布的一个可用的支持版本~  
+> 如果想在 **Python <= 3.9** 的环境中使用，请选择 `v0.5.8`，这是最后一个支持 **Python <= 3.9** 的 Release
+>
+> ~严格来说其实是第一个以及最后一个，因为之前的版本有不适用于**非3.10以下**的类型注解语法，为此专门发布的一个可用的支持版本~
+>
 > 对于其他**非** `v0.5.8` 版本，都有可能不兼容 **Python <= 3.9**
 
 ## 🎉 使用
@@ -103,6 +105,7 @@ skland_arksign_allow_group=True
 
 > [!IMPORTANT]
 > 在群聊中使用命令时，命令的权限会受到较大限制
+>
 > 基本只有[超级用户](https://nonebot.dev/docs/appendices/config#superusers)可以使用
 
 ### 新增账号
@@ -112,7 +115,10 @@ skland add 舟游戏ID [森空岛token] [-n 可选备注]
 ```
 
 > [!IMPORTANT]
+> 舟游戏ID为游戏主界面博士名下面那串数字（如`114514`）
+>
 > 在群聊中使用时，一定不要带上token，否则会有盗号风险
+>
 > 缺少的token会在私聊中补充：[使用 bind 命令](#私信补充token)
 
 #### 获取Token
@@ -136,9 +142,12 @@ skland add 舟游戏ID [森空岛token] [-n 可选备注]
 3. 将`<Token>`填入命令中
 
 > [!NOTE]
-> 例子: `"content": "1145141919810"`
+> 例子: 舟游戏ID为114514，访问得到内容 `"content": "1145141919810"`
 >
-> 则命令为 `森空岛 add 你的游戏UID 1145141919810`
+> 则命令为 `森空岛 add 114514 1145141919810`
+
+> [!IMPORTANT]
+> 注意不要把包裹`content`内容的引号，或是页面返回的整个内容输入到命令中！
 
 #### 私信补充token
 
@@ -191,6 +200,7 @@ skland signin !all
 
 > [!WARNING]
 > 仅超级用户可用
+>
 > 签到全部用户时，会分发到原本对应的聊天目标
 
 ## ♿️ FAQ
@@ -213,6 +223,21 @@ skland signin !all
    skland signin 1919810
    ```
 
+3. 为什么我刚获取token并绑定好，一会就用不了了？
+
+- 当您使用浏览器获取token时，**不要去登出账号，否则鹰角网络通行证会失效！**
+- 如果要添加多个账号，请删除浏览器缓存。或者使用浏览器自带的隐私浏览模式，拿到Token后，关闭隐私窗口，再登录一次即可
+- 注意：电脑在用密码登录后，手机客户端有可能会被挤掉，但一定不要点客户端里的清理会话，否则所有的登录状态**都会被清空！**
+
+4. 报错`{'code': 10001, 'message': '当前用户未经授权'}`？
+
+- 参考 [#新增账号](#新增账号) 一栏重新绑定舟游戏ID
+- 参考issue：[#29](https://github.com/GuGuMur/nonebot-plugin-skland-arksign/issues/29)
+
+5. 报错`Client error '400 Bad Request' for url xxx`？
+
+- 请检查token复制过程中是否有错漏，以及舟游戏ID是否与您输入的token相符
+
 ## 🤗 致谢
 
 - `xxyz30/skyland-auto-sign`([<del>Github</del>](https://github.com/xxyz30/skyland-auto-sign)/[Gitee](https://gitee.com/FancyCabbage/skyland-auto-sign))、[`Yanstory/skland-checkin-ghaction`](https://github.com/Yanstory/skland-checkin-ghaction)、[`Maojuan-lang/SenKongDao`](https://github.com/Maojuan-lang/SenKongDao)：感谢以上项目提供的参考！

nonebot_plugin_skland_arksign/config.py

@@ -21,6 +21,7 @@ def init_des(self) -> str:
             return cleantext("""
                 森空岛自动签到插件
                 使用：森空岛 add [游戏账号ID] [森空岛token]
+                如何获取token：登录森空岛（https://www.skland.com/ ）后访问网址（https://web-api.skland.com/account/info/hg ），看到的"content"中内容即为token。
                 """)
 
     @property
@@ -34,8 +35,8 @@ def del_des(self) -> str:
     @property
     def use_example(self) -> str:
         return cleantext("""
-            /森空岛 add [游戏账号ID] [森空岛token]
-            /森空岛 del [游戏账号ID]
+            /森空岛 add 1234567890 ABCDEFG*/a
+            /森空岛 del 1234567890
             /森空岛 list
             """)
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nonebot-plugin-skland-arksign"
-version = "0.6.0"
+version = "0.6.1"
 description = "用于每日定时签到森空岛明日方舟的Nonebot插件"
 authors = [
     {name = "GuGuMur", email = "[email protected]"},