doc 更新文档

chr233 · Aug 15, 2024 · 9f698fd · 9f698fd
1 parent f73e199
commit 9f698fd
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 16 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<Version>2.2.1.0</Version>
+		<Version>2.2.1.1</Version>
 	</PropertyGroup>
 
 	<PropertyGroup>

diff --git a/README.en.md b/README.en.md
@@ -55,6 +55,7 @@
 
 Supported Plugin List:
 
+- [ASFMultipleProxy](https://github.com/chr233/ASFMultipleProxy)
 - [ASFBuffBot](https://github.com/chr233/ASFBuffBot) (Bugfix WIP)
 - [ASFOAuth](https://github.com/chr233/ASFOAuth)
 - [ASFTradeExtension](https://github.com/chr233/ASFTradeExtension) (Bugfix WIP)
@@ -109,7 +110,8 @@ Command: `UPDATEPLUGINS stable ASFEnhance`
 
 | ASFEnhance Version                                                     | Depended ASF Version | Description                                              |
 | ---------------------------------------------------------------------- | :------------------: | -------------------------------------------------------- |
-| [2.2.0.0](https://github.com/chr233/ASFEnhance/releases/tag/2.2.0.0)   |       6.0.5.2        | ASF -> 6.0.5.2, 改进翻译                                 |
+| [2.2.1.1](https://github.com/chr233/ASFEnhance/releases/tag/2.2.1.1)   |       6.0.5.2        | 新增 `NOTIFICATION` 命令, bugfix                         |
+| [2.2.0.4](https://github.com/chr233/ASFEnhance/releases/tag/2.2.0.4)   |       6.0.5.2        | ASF -> 6.0.5.2, 改进翻译                                 |
 | [2.1.12.0](https://github.com/chr233/ASFEnhance/releases/tag/2.1.12.0) |       6.0.4.4        | 改进翻译, 新增 `IGNOREGAME` 命令                         |
 | [2.1.11.0](https://github.com/chr233/ASFEnhance/releases/tag/2.1.11.0) |       6.0.4.4        | 改进翻译, 新增 `REGISTEDATE` 命令                        |
 | [2.1.10.3](https://github.com/chr233/ASFEnhance/releases/tag/2.1.10.3) |       6.0.4.4        | ASF -> 6.0.4.4, 改进翻译, 新增 `CRAFTSPECIFYBADGES` 命令 |
@@ -233,7 +235,7 @@ Command: `UPDATEPLUGINS stable ASFEnhance`
 
 > The configuration of this plugin is not necessary. You can use most functions by keeping the default configuration.
 
-ASF.json
+### ASF.json
 
 ```json
 {
@@ -291,6 +293,24 @@ ASF.json
 >
 > \*\*\* `Address` and `Addresses` are the same configuration item. If you need to use the fixed area function, only configure one. You don’t need to configure both. If you don’t need this function, you don’t need to configure it.
 
+### Bot.json
+
+```json
+{
+  //Bot Configuration
+  "Enabled": true,
+  "SteamLogin": "",
+  "SteamPassword": "",
+  "...": "...",
+  //ASFEnhance Configuration
+  "UserCountry": "CN"
+}
+```
+
+| Configuration | Type     | Default | Description                                                                                             |
+| ------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
+| `UserCountry` | `string` | `null`  | Will effect on Cart Commands, if not set, plugin will convert bot's wallet currency to the country code |
+
 ## Commands Usage
 
 ### Update Commands
@@ -506,9 +526,10 @@ All avatars are from [Game Avatars Page](https://steamcommunity.com/actions/Game
 
 ### Community Commands
 
-| Command                    | Shorthand | Access     | Description                                  |
-| -------------------------- | --------- | ---------- | -------------------------------------------- |
-| `CLEARNOTIFICATION [Bots]` | `CN`      | `Operator` | Clear new item and new message notifications |
+| Command                    | Shorthand | Access     | Description                      |
+| -------------------------- | --------- | ---------- | -------------------------------- |
+| `NOTIFICATION [Bots]`      | `N`       | `Operator` | Get the bot's notification list  |
+| `CLEARNOTIFICATION [Bots]` | `CN`      | `Operator` | Mark bot's notifications as read |
 
 ### Friend Commands
 

diff --git a/README.md b/README.md
@@ -57,6 +57,7 @@ ASFEnhance 介绍 & 使用指南: [https://keylol.com/t804841-1-1](https://keylo
 
 受支持的插件列表:
 
+- [ASFMultipleProxy](https://github.com/chr233/ASFMultipleProxy)
 - [ASFBuffBot](https://github.com/chr233/ASFBuffBot)
 - [ASFOAuth](https://github.com/chr233/ASFOAuth)
 - [ASFTradeExtension](https://github.com/chr233/ASFTradeExtension)
@@ -112,7 +113,8 @@ ASFEnhance 介绍 & 使用指南: [https://keylol.com/t804841-1-1](https://keylo
 
 | ASFEnhance 版本                                                        | 适配 ASF 版本 | 更新说明                                                 |
 | ---------------------------------------------------------------------- | :-----------: | -------------------------------------------------------- |
-| [2.2.0.0](https://github.com/chr233/ASFEnhance/releases/tag/2.2.0.0)   |    6.0.5.2    | ASF -> 6.0.5.2, 改进翻译                                 |
+| [2.2.1.1](https://github.com/chr233/ASFEnhance/releases/tag/2.2.1.1)   |    6.0.5.2    | 新增 `NOTIFICATION` 命令, bugfix                         |
+| [2.2.0.4](https://github.com/chr233/ASFEnhance/releases/tag/2.2.0.4)   |    6.0.5.2    | ASF -> 6.0.5.2, 改进翻译                                 |
 | [2.1.12.0](https://github.com/chr233/ASFEnhance/releases/tag/2.1.12.0) |    6.0.4.4    | 改进翻译, 新增 `IGNOREGAME` 命令                         |
 | [2.1.11.0](https://github.com/chr233/ASFEnhance/releases/tag/2.1.11.0) |    6.0.4.4    | 改进翻译, 新增 `REGISTEDATE` 命令                        |
 | [2.1.10.3](https://github.com/chr233/ASFEnhance/releases/tag/2.1.10.3) |    6.0.4.4    | ASF -> 6.0.4.4, 改进翻译, 新增 `CRAFTSPECIFYBADGES` 命令 |
@@ -235,7 +237,7 @@ ASFEnhance 介绍 & 使用指南: [https://keylol.com/t804841-1-1](https://keylo
 
 > 本插件的配置不是必须的, 保持默认配置即可使用大部分功能
 
-ASF.json
+### ASF.json
 
 ```json
 {
@@ -299,6 +301,24 @@ ASF.json
 >
 > \*\*\* `Address` 与 `Addresses` 为同一个配置项, 如果需要使用定区功能 , 仅配置一个即可, 不需要都配置, 如果不需要这个功能也可以不配置
 
+### Bot.json
+
+```json
+{
+  //机器人配置
+  "Enabled": true,
+  "SteamLogin": "",
+  "SteamPassword": "",
+  "...": "...",
+  //ASFEnhance配置
+  "UserCountry": "CN"
+}
+```
+
+| 配置项        | 类型     | 默认值 | 说明                                                                                   |
+| ------------- | -------- | ------ | -------------------------------------------------------------------------------------- |
+| `UserCountry` | `string` | `null` | 为机器人指定国家代码, 影响购物车相关命令, 未指定时插件会根据机器人钱包货币选择国家代码 |
+
 ## 插件指令说明
 
 ### 插件测试
@@ -510,9 +530,10 @@ ASF.json
 
 ### 社区相关
 
-| 命令                       | 缩写 | 权限       | 说明                   |
-| -------------------------- | ---- | ---------- | ---------------------- |
-| `CLEARNOTIFICATION [Bots]` | `CN` | `Operator` | 清除新物品和新留言通知 |
+| 命令                       | 缩写 | 权限       | 说明                              |
+| -------------------------- | ---- | ---------- | --------------------------------- |
+| `NOTIFICATION [Bots]`      | `N`  | `Operator` | 查看通知列表, 前缀`*`代表未读通知 |
+| `CLEARNOTIFICATION [Bots]` | `CN` | `Operator` | 将所有通知标记为已读              |
 
 ### 好友相关
 

diff --git a/README.ru.md b/README.ru.md
@@ -55,6 +55,7 @@
 
 Список поддерживаемых плагинов.
 
+- [ASFMultipleProxy](https://github.com/chr233/ASFMultipleProxy)
 - [ASFBuffBot](https://github.com/chr233/ASFBuffBot) (Bugfix WIP)
 - [ASFOAuth](https://github.com/chr233/ASFOAuth)
 - [ASFTradeExtension](https://github.com/chr233/ASFTradeExtension) (Bugfix WIP)
@@ -107,7 +108,8 @@ Command: `UPDATEPLUGINS stable ASFEnhance`
 
 | Версия ASFEnhance                                                      | Совместимая версия ASF | Описание                                                 |
 | ---------------------------------------------------------------------- | :--------------------: | -------------------------------------------------------- |
-| [2.2.0.0](https://github.com/chr233/ASFEnhance/releases/tag/2.2.0.0)   |        6.0.5.2         | ASF -> 6.0.5.2, 改进翻译                                 |
+| [2.2.1.1](https://github.com/chr233/ASFEnhance/releases/tag/2.2.1.1)   |        6.0.5.2         | 新增 `NOTIFICATION` 命令, bugfix                         |
+| [2.2.0.4](https://github.com/chr233/ASFEnhance/releases/tag/2.2.0.4)   |        6.0.5.2         | ASF -> 6.0.5.2, 改进翻译                                 |
 | [2.1.12.0](https://github.com/chr233/ASFEnhance/releases/tag/2.1.12.0) |        6.0.4.4         | 改进翻译, 新增 `IGNOREGAME` 命令                         |
 | [2.1.11.0](https://github.com/chr233/ASFEnhance/releases/tag/2.1.11.0) |        6.0.4.4         | 改进翻译, 新增 `REGISTEDATE` 命令                        |
 | [2.1.10.3](https://github.com/chr233/ASFEnhance/releases/tag/2.1.10.3) |        6.0.4.4         | ASF -> 6.0.4.4, 改进翻译, 新增 `CRAFTSPECIFYBADGES` 命令 |
@@ -227,7 +229,7 @@ Command: `UPDATEPLUGINS stable ASFEnhance`
 
 > Настройка этого плагина не требуется, большинство функций доступно в настройках по умолчанию
 
-ASF.json
+### ASF.json
 
 ```json
 {
@@ -285,6 +287,24 @@ ASF.json
 >
 > \*\*\* `Address` и `Addresses` это одна и та же конфигурация
 
+### Bot.json
+
+```json
+{
+  //Bot Configuration
+  "Enabled": true,
+  "SteamLogin": "",
+  "SteamPassword": "",
+  "...": "...",
+  //ASFEnhance Configuration
+  "UserCountry": "CN"
+}
+```
+
+| Конфигурация  | Тип      | По умолчанию | Описание                                                                                                |
+| ------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------- |
+| `UserCountry` | `string` | `null`       | Will effect on Cart Commands, if not set, plugin will convert bot's wallet currency to the country code |
+
 ## Использование Команд
 
 ### Команды Обновления
@@ -498,9 +518,10 @@ ASF.json
 
 ### Команды Сообщества
 
-| Команда                    | Сокращение | Доступ     | Описание                                                               |
-| -------------------------- | ---------- | ---------- | ---------------------------------------------------------------------- |
-| `CLEARNOTIFICATION [Bots]` | `CN`       | `Operator` | Очистить уведомления о новых предметах инвентаря и новых комментариях. |
+| Команда                    | Сокращение | Доступ     | Описание                         |
+| -------------------------- | ---------- | ---------- | -------------------------------- |
+| `NOTIFICATION [Bots]`      | `N`        | `Operator` | Get the bot's notification list  |
+| `CLEARNOTIFICATION [Bots]` | `CN`       | `Operator` | Mark bot's notifications as read |
 
 ### Команды друзей