Skip to content

Commit

Permalink
doc 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
@chr233
chr233 committed Dec 19, 2023
1 parent c7b308b commit 1640920
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 55 deletions.
44 changes: 28 additions & 16 deletions README.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ Supported Plugin List:

| ASFEnhance Version | Depended ASF Version | Description |
| -------------------------------------------------------------------- | :------------------: | ----------------------------------------------------------------- |
| [2.0.5.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.5.0) | 5.5.0.11 | 修改 `REPLAY` 命令, ASF -> 5.5.0.11 |
| [2.0.4.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.4.0) | 5.5.0.10 | 新增 `CHECKAPIKEY` `REVOKEAPIKEY` 命令 |
| [2.0.3.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.3.1) | 5.5.0.10 | ASF -> 5.5.0.10, 迁移到 .net8 |
| [2.0.2.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.2.0) | 5.4.13.4 | ASF -> 5.4.13.4 |
| [2.0.1.3](https://github.com/chr233/ASFEnhance/releases/tag/2.0.1.3) | 5.4.12.5 | New `VOTE` `CHECKVOTE` commands |
Expand All @@ -86,6 +88,13 @@ Supported Plugin List:
<details>
<summary>History Version</summary>

> ASF 5.5.0.11 开始使用 .Net8.0, 旧版本插件无法适配新版本 ASF
| ASFEnhance 版本 | 依赖 ASF 版本 | 5.4.10.3 | 5.4.12.5 | 5.4.13.4 | 5.5.0.11 |
| -------------------------------------------------------------------- | :-----------: | :------: | :------: | :------: | :------: |
| [2.0.1.3](https://github.com/chr233/ASFEnhance/releases/tag/2.0.1.3) | 5.4.12.5 | ❌ | ✔️ | ✔️ | ❌ |
| [2.0.0.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.0.0) | 5.4.12.5 | ❌ | ✔️ | ✔️ | ❌ |

> ASF 5.4.10.3 and previous versions are no longer supported due to changes in Steam. Please use the new version of ASF and ASFEnhance.
| ASFEnhance Version | Depended ASF Version | 5.4.7.3 | 5.4.8.3 | 5.4.9.3 |
Expand Down Expand Up @@ -254,6 +263,9 @@ ASF.json
| `GETBOTBANN [Bots]` | | | Same command as `GETBOTBANNED` |
| `GETACCOUNTBANNED <SteamIds>` | `GBB` | `Operator` | Get the ban status of the specified account, supports SteamId 64 / SteamId 32 |
| `GETACCOUNTBAN <SteamIds>` | | | Same command as `GETACCOUNTBANNED` |
| `EMAIL [Bots]` | `EM` | `Operator` | Get bot's email |
| `CHECKAPIKEY [Bots]` | | `Operator` | Check if ApiKey exists |
| `REVOKEAPIKEY [Bots]` | | `Master` | Revoke current ApiKey |

- `SETEMAILOPTION` parameters explanation

Expand Down Expand Up @@ -317,22 +329,22 @@ ASF.json
## Profile Commands

| Command | Shorthand | Access | Description |
| -------------------------------------- | --------- | --------------- | -------------------------------------------------------------------------------------------------------- |
| `PROFILE [Bots]` | `PF` | `FamilySharing` | Get the bot(s) profile infomation |
| `PROFILELINK [Bots]` | `PFL` | `FamilySharing` | Get the bot(s) profile link |
| `STEAMID [Bots]` | `SID` | `FamilySharing` | Get the bot(s) steamID |
| `FRIENDCODE [Bots]` | `FC` | `FamilySharing` | Get the bot(s) friend code |
| `TRADELINK [Bots]` | `TL` | `Operator` | Get the bot(s) trade link |
| `REPLAY [Bots]` | `RP` | `Operator` | Get the bot(s) «Steam Awards 2022» banner link (can get badge) |
| `REPLAYPRIVACY [Bots] Privacy` | `RPP` | `Operator` | Set the privacy settings for `Steam Replay 2022`. `Privacy`: `1=Private` `2=Only friends` `3=Public` |
| `CLEARALIAS [Bots]` | | `Opetator` | Clear history of previously used names |
| `GAMEAVATAR [Bots] <AppID> [AvatarID]` | `GA` | `Master` | Set the bot(s) avatar as given `AppID` and `AvatarID`, if not set `AvatarId`, plugin will use random one |
| `RANDOMGAMEAVATAR [Bots]` | `RGA` | `Master` | Set the bot(s) avatar randomly |
| `ADVNICKNAME [Bots] Query` | `ANN` | `Master` | Set the bot(s) nickname use `Placeholder`, avilable: `%dn%` `%ln%` `%un%` `%botn%`, case insensitive |
| `SETAVATAR [Bots] ImageUrl` 🐞 | `GA` | `Master` | Set the bot(s) avatar to specified online image |
| `DELETEAVATAR [Bots]` 🐞 | | `Master` | Delete the bots avatar (reset to default) |
| `CRAFTBADGE [Bots]` | `CB` | `Master` | Automatically craft ALL craftable badges (craft every craftable badge once at one time) |
| Command | Shorthand | Access | Description |
| -------------------------------------- | --------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `PROFILE [Bots]` | `PF` | `FamilySharing` | Get the bot(s) profile infomation |
| `PROFILELINK [Bots]` | `PFL` | `FamilySharing` | Get the bot(s) profile link |
| `STEAMID [Bots]` | `SID` | `FamilySharing` | Get the bot(s) steamID |
| `FRIENDCODE [Bots]` | `FC` | `FamilySharing` | Get the bot(s) friend code |
| `TRADELINK [Bots]` | `TL` | `Operator` | Get the bot(s) trade link |
| `REPLAY [Year] [Bots]` | `RP` | `Operator` | Get the bot(s) «Steam Awards 2022» banner link (can get badge), if given 2 or more args, the first will be treat as Year(2022/2023) |
| `REPLAYPRIVACY [Year] [Bots] Privacy` | `RPP` | `Operator` | Set the privacy settings for `Steam Replay 2022`. `Privacy`: `1=Private` `2=Only friends` `3=Public`, if given 3 or more args, the first will be treat as Year(2022/2023) |
| `CLEARALIAS [Bots]` | | `Opetator` | Clear history of previously used names |
| `GAMEAVATAR [Bots] <AppID> [AvatarID]` | `GA` | `Master` | Set the bot(s) avatar as given `AppID` and `AvatarID`, if not set `AvatarId`, plugin will use random one |
| `RANDOMGAMEAVATAR [Bots]` | `RGA` | `Master` | Set the bot(s) avatar randomly |
| `ADVNICKNAME [Bots] Query` | `ANN` | `Master` | Set the bot(s) nickname use `Placeholder`, avilable: `%dn%` `%ln%` `%un%` `%botn%`, case insensitive |
| `SETAVATAR [Bots] ImageUrl` 🐞 | `GA` | `Master` | Set the bot(s) avatar to specified online image |
| `DELETEAVATAR [Bots]` 🐞 | | `Master` | Delete the bots avatar (reset to default) |
| `CRAFTBADGE [Bots]` | `CB` | `Master` | Automatically craft ALL craftable badges (craft every craftable badge once at one time) |

\*🐞: Requires the generic version of ASF (**not** generic-netf)

Expand Down
52 changes: 29 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,23 @@ ASFEnhance 介绍 & 使用指南: [https://keylol.com/t804841-1-1](https://keylo

### 更新日志

| ASFEnhance 版本 | 适配 ASF 版本 | 更新说明 |
| -------------------------------------------------------------------- | :-----------: | ---------------------------------------------------- |
| [2.0.4.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.4.0) | 5.5.0.10 | 新增 `CHECKAPIKEY` `REVOKEAPIKEY` 命令 |
| [2.0.3.2](https://github.com/chr233/ASFEnhance/releases/tag/2.0.3.2) | 5.5.0.10 | ASF -> 5.5.0.10, 迁移到 .net8 |
| [2.0.2.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.2.0) | 5.4.13.4 | ASF -> 5.4.13.4 |
| [2.0.1.3](https://github.com/chr233/ASFEnhance/releases/tag/2.0.1.3) | 5.4.12.5 | 新增 `VOTE` `CHECKVOTE` 命令 |
| [2.0.0.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.0.0) | 5.4.12.5 | ASF -> 5.4.12.5, 新的子模块系统, 新增 `EMAIL` 命令等 |
| ASFEnhance 版本 | 适配 ASF 版本 | 更新说明 |
| -------------------------------------------------------------------- | :-----------: | -------------------------------------- |
| [2.0.5.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.5.0) | 5.5.0.11 | 修改 `REPLAY` 命令, ASF -> 5.5.0.11 |
| [2.0.4.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.4.0) | 5.5.0.10 | 新增 `CHECKAPIKEY` `REVOKEAPIKEY` 命令 |
| [2.0.3.2](https://github.com/chr233/ASFEnhance/releases/tag/2.0.3.2) | 5.5.0.10 | ASF -> 5.5.0.10, 迁移到 .net8 |
| [2.0.2.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.2.0) | 5.4.13.4 | ASF -> 5.4.13.4, 最后一个 .net7 的版本 |

<details>
<summary>历史版本</summary>

> ASF 5.5.0.11 开始使用 .Net8.0, 旧版本插件无法适配新版本 ASF
| ASFEnhance 版本 | 依赖 ASF 版本 | 5.4.10.3 | 5.4.12.5 | 5.4.13.4 | 5.5.0.11 |
| -------------------------------------------------------------------- | :-----------: | :------: | :------: | :------: | :------: |
| [2.0.1.3](https://github.com/chr233/ASFEnhance/releases/tag/2.0.1.3) | 5.4.12.5 | ❌ | ✔️ | ✔️ | ❌ |
| [2.0.0.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.0.0) | 5.4.12.5 | ❌ | ✔️ | ✔️ | ❌ |

> ASF 5.4.10.3 以及之前的版本因为 Steam 的改动已经无法使用, 请使用新版本的 ASF 和 ASFEnhance
| ASFEnhance 版本 | 依赖 ASF 版本 | 5.4.7.3 | 5.4.8.3 | 5.4.9.3 |
Expand Down Expand Up @@ -318,22 +324,22 @@ ASF.json
### 个人资料相关

| 命令 | 缩写 | 权限 | 说明 |
| -------------------------------------- | ----- | --------------- | ----------------------------------------------------------------------------------- |
| `PROFILE [Bots]` | `PF` | `FamilySharing` | 查看个人资料 |
| `PROFILELINK [Bots]` | `PFL` | `FamilySharing` | 查看个人资料链接 |
| `STEAMID [Bots]` | `SID` | `FamilySharing` | 查看 steamID |
| `FRIENDCODE [Bots]` | `FC` | `FamilySharing` | 查看好友代码 |
| `TRADELINK [Bots]` | `TL` | `Operator` | 查看交易链接 |
| `REPLAY [Bots]` | `RP` | `Operator` | 获取摘要图片链接 (可以解锁徽章) |
| `REPLAYPRIVACY [Bots] Privacy` | `RPP` | `Operator` | 设置年度总结可见性, `Privacy` 1=私密 2=好友可见 3=公开 |
| `CLEARALIAS [Bots]` | | `Opetator` | 清除曾用名 |
| `GAMEAVATAR [Bots] <AppID> [AvatarID]` | `GA` | `Master` | 根据指定 `AppID` 和 `AvatarID` 设置机器人的头像, 省略 `AvatarId` 时将随机选择头像 |
| `RANDOMGAMEAVATAR [Bots]` | `RGA` | `Master` | 设置机器人的头像为随机游戏头像 |
| `ADVNICKNAME [Bots] Query` | `ANN` | `Master` | 使用 `占位符` 设置机器人昵称, 可用占位符 `%dn%` `%ln%` `%un%` `%botn%` 不区分大小写 |
| `SETAVATAR [Bots] ImageUrl` 🐞\* | `GA` | `Master` | 设置机器人的头像为指定网络图片 |
| `DELETEAVATAR [Bots]` 🐞\* | | `Master` | 删除机器人的头像(设置为默认头像) |
| `CRAFTBADGE [Bots]` | `CB` | `Master` | 自动合成可合成徽章 (每个可升级徽章合成一级) |
| 命令 | 缩写 | 权限 | 说明 |
| -------------------------------------- | ----- | --------------- | ----------------------------------------------------------------------------------------------------- |
| `PROFILE [Bots]` | `PF` | `FamilySharing` | 查看个人资料 |
| `PROFILELINK [Bots]` | `PFL` | `FamilySharing` | 查看个人资料链接 |
| `STEAMID [Bots]` | `SID` | `FamilySharing` | 查看 steamID |
| `FRIENDCODE [Bots]` | `FC` | `FamilySharing` | 查看好友代码 |
| `TRADELINK [Bots]` | `TL` | `Operator` | 查看交易链接 |
| `REPLAY [Year] [Bots]` | `RP` | `Operator` | 获取摘要图片链接 (可以解锁徽章) , 使用 2 个及以上参数时第一个参数视为指定年份, 比如 `Replay 2022 bot` |
| `REPLAYPRIVACY [Year] [Bots] Privacy` | `RPP` | `Operator` | 设置年度总结可见性, `Privacy` 1=私密 2=好友可见 3=公开 , 使用 3 个及以上参数时第一个参数视为指定年份 |
| `CLEARALIAS [Bots]` | | `Opetator` | 清除曾用名 |
| `GAMEAVATAR [Bots] <AppID> [AvatarID]` | `GA` | `Master` | 根据指定 `AppID` 和 `AvatarID` 设置机器人的头像, 省略 `AvatarId` 时将随机选择头像 |
| `RANDOMGAMEAVATAR [Bots]` | `RGA` | `Master` | 设置机器人的头像为随机游戏头像 |
| `ADVNICKNAME [Bots] Query` | `ANN` | `Master` | 使用 `占位符` 设置机器人昵称, 可用占位符 `%dn%` `%ln%` `%un%` `%botn%` 不区分大小写 |
| `SETAVATAR [Bots] ImageUrl` 🐞\* | `GA` | `Master` | 设置机器人的头像为指定网络图片 |
| `DELETEAVATAR [Bots]` 🐞\* | | `Master` | 删除机器人的头像(设置为默认头像) |
| `CRAFTBADGE [Bots]` | `CB` | `Master` | 自动合成可合成徽章 (每个可升级徽章合成一级) |

\*🐞: 需要使用 generic 版本的 ASF (**非** generic-netf)

Expand Down
Loading

0 comments on commit 1640920

Please sign in to comment.