Skip to content

Commit

Permalink
doc 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
chr233 committed Feb 4, 2024
1 parent 7166d3c commit 170162b
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 49 deletions.
40 changes: 22 additions & 18 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,30 +78,32 @@ Supported Plugin List:

### ChangeLog

| ASFEnhance Version | Depended ASF Version | Description |
| ---------------------------------------------------------------------- | :------------------: | ----------------------------------------------------------------- |
| [2.0.11.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.11.1) | 5.5.2.3 | ASF -> 5.5.2.3, 旧版本不兼容 |
| [2.0.10.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.10.1) | 5.5.1.4 | 新增 `REDEEMPOINTSITEM`, `REDEEMPOINTSBADGE` 命令 |
| [2.0.9.3](https://github.com/chr233/ASFEnhance/releases/tag/2.0.9.3) | 5.5.1.4 | ASF -> 5.5.1.4 , 自动领取增加配置项, 修复 `CRAFTBADGE` 命令 |
| [2.0.8.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.8.0) | 5.5.0.11 | 修改 `CLAIMITEM` 命令, 支持自动领取 |
| [2.0.7.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.7.0) | 5.5.0.11 | 修改 `PURCHASEGIFT` 命令, 支持指定 SteamID |
| [2.0.6.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.6.0) | 5.5.0.11 | 修改 `VOTE` `CHECKVOTE` 命令, 适配 Steam Award 投票 |
| [2.0.5.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.5.1) | 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 |
| [2.0.0.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.0.0) | 5.4.12.5 | ASF -> 5.4.12.5, new submodule system, new `EMAIL` commands, etc. |
| ASFEnhance Version | Depended ASF Version | Description |
| ---------------------------------------------------------------------- | :------------------: | ----------------------------------------------------------- |
| [2.0.12.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.12.0) | 5.5.2.3 | 新增 `EDITCUSTOMURL`, `DELETECUSTOMURL` 命令 |
| [2.0.11.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.11.1) | 5.5.2.3 | ASF -> 5.5.2.3, 旧版本不兼容 |
| [2.0.10.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.10.1) | 5.5.1.4 | 新增 `REDEEMPOINTSITEM`, `REDEEMPOINTSBADGE` 命令 |
| [2.0.9.3](https://github.com/chr233/ASFEnhance/releases/tag/2.0.9.3) | 5.5.1.4 | ASF -> 5.5.1.4 , 自动领取增加配置项, 修复 `CRAFTBADGE` 命令 |

<details>
<summary>History Version</summary>

| ASFEnhance Version | Depended ASF Version | 5.5.0.x | 5.5.1.4 | 5.5.2.3 |
| -------------------------------------------------------------------- | :------------------: | :-----: | :-----: | :-----: |
| [2.0.8.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.8.0) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.7.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.7.0) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.6.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.6.0) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.5.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.5.1) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.4.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.4.0) | 5.5.0.10 | ✔️ | ✔️ ||
| [2.0.3.2](https://github.com/chr233/ASFEnhance/releases/tag/2.0.3.2) | 5.5.0.10 | ✔️ | ✔️ ||

> 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 || ✔️ | ✔️ ||
| ASFEnhance Version | Depended ASF Version | 5.4.10.3 | 5.4.12.5 | 5.4.13.4 | 5.5.0.x |
| -------------------------------------------------------------------- | :------------------: | :------: | :------: | :------: | :-----: |
| [2.0.2.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.2.0) | 5.4.13.4 ||| ✔️ ||
| [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.
Expand Down Expand Up @@ -357,6 +359,8 @@ ASF.json
| `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) |
| `EDITCUSTOMURL [Bot] CustomUrl` | `ECU` | `Master` | Edit bot's custom profile url |
| `DELETECUSTOMURL [Bots]` | `DCU` | `Master` | Delete bot's custom profile url |

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

Expand Down
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,26 +82,30 @@ ASFEnhance 介绍 & 使用指南: [https://keylol.com/t804841-1-1](https://keylo

| ASFEnhance 版本 | 适配 ASF 版本 | 更新说明 |
| ---------------------------------------------------------------------- | :-----------: | ----------------------------------------------------------- |
| [2.0.11.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.11.1) | 5.5.2.3 | ASF -> 5.5.2.3, 旧版本不兼容 |
| [2.0.12.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.12.0) | 5.5.2.3 | 新增 `EDITCUSTOMURL`, `DELETECUSTOMURL` 命令 |
| [2.0.11.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.11.1) | 5.5.2.3 | ASF -> 5.5.2.3, 旧版本不兼容 |
| [2.0.10.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.10.1) | 5.5.1.4 | 新增 `REDEEMPOINTSITEM`, `REDEEMPOINTSBADGE` 命令 |
| [2.0.9.3](https://github.com/chr233/ASFEnhance/releases/tag/2.0.9.3) | 5.5.1.4 | ASF -> 5.5.1.4 , 自动领取增加配置项, 修复 `CRAFTBADGE` 命令 |
| [2.0.8.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.8.0) | 5.5.0.11 | 修改 `CLAIMITEM` 命令, 支持自动领取 |
| [2.0.7.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.7.0) | 5.5.0.11 | 修改 `PURCHASEGIFT` 命令, 支持指定 SteamID |
| [2.0.6.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.6.0) | 5.5.0.11 | 修改 `VOTE` `CHECKVOTE` 命令, 适配 Steam Award 投票 |
| [2.0.5.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.5.1) | 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>

| ASFEnhance 版本 | 依赖 ASF 版本 | 5.5.0.x | 5.5.1.4 | 5.5.2.3 |
| -------------------------------------------------------------------- | :-----------: | :-----: | :-----: | :-----: |
| [2.0.8.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.8.0) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.7.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.7.0) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.6.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.6.0) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.5.1](https://github.com/chr233/ASFEnhance/releases/tag/2.0.5.1) | 5.5.0.11 | ✔️ | ✔️ ||
| [2.0.4.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.4.0) | 5.5.0.10 | ✔️ | ✔️ ||
| [2.0.3.2](https://github.com/chr233/ASFEnhance/releases/tag/2.0.3.2) | 5.5.0.10 | ✔️ | ✔️ ||

> 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 || ✔️ | ✔️ ||
| ASFEnhance 版本 | 依赖 ASF 版本 | 5.4.10.3 | 5.4.12.5 | 5.4.13.4 | 5.5.0.x |
| -------------------------------------------------------------------- | :-----------: | :------: | :------: | :------: | :-----: |
| [2.0.2.0](https://github.com/chr233/ASFEnhance/releases/tag/2.0.2.0) | 5.4.13.4 ||| ✔️ ||
| [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
Expand Down Expand Up @@ -171,7 +175,7 @@ ASFEnhance 介绍 & 使用指南: [https://keylol.com/t804841-1-1](https://keylo
| [1.6.14.0](https://github.com/chr233/ASFEnhance/releases/tag/1.6.14.0) | 5.3.1.2 |||| ✔️ | ✔️ |
| [1.6.12.717](https://github.com/chr233/ASFEnhance/releases/tag/1.6.12.717) | 5.3.1.2 |||| ✔️ | ✔️ |
| [1.6.11.670](https://github.com/chr233/ASFEnhance/releases/tag/1.6.11.670) | 5.3.1.2 |||| ✔️ | ✔️ |
| [1.6.10.666](https://github.com/chr233/ASFEnhance/releases/tag/1.6.10.666) | 5.3.0.3 |||| ✔️ | ✔️\* |
| [1.6.10.666](https://github.com/chr233/ASFEnhance/releases/tag/1.6.10.666) | 5.3.0.3 |||| ✔️ | ✔️ |
| [1.6.9.663](https://github.com/chr233/ASFEnhance/releases/tag/1.6.9.663) | 5.2.8.4 ||| ✔️ || |
| [1.6.8.661](https://github.com/chr233/ASFEnhance/releases/tag/1.6.8.661) | 5.2.7.7 || ✔️ | | | |

Expand Down Expand Up @@ -354,6 +358,8 @@ ASF.json
| `SETAVATAR [Bots] ImageUrl` 🐞\* | `GA` | `Master` | 设置机器人的头像为指定网络图片 |
| `DELETEAVATAR [Bots]` 🐞\* | | `Master` | 删除机器人的头像(设置为默认头像) |
| `CRAFTBADGE [Bots]` | `CB` | `Master` | 自动合成可合成徽章 (每个可升级徽章合成一级) |
| `EDITCUSTOMURL [Bot] CustomUrl` | `ECU` | `Master` | 修改自定义个人资料链接 |
| `DELETECUSTOMURL [Bots]` | `DCU` | `Master` | 删除自定义个人资料链接 |

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

Expand Down
Loading

0 comments on commit 170162b

Please sign in to comment.