Skip to content

Commit

Permalink
doc 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
chr233 committed Oct 11, 2022
1 parent ee89dd9 commit 81ca55a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 16 deletions.
25 changes: 17 additions & 8 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,6 @@

[中文说明](README.md)

## Steam Next Fest

> Avilable during 10.3 - 10.10
| Command | Shorthand | Access | Description |
| ------- | --------- | ---------- | ----------------------------------- |
| `EVENT` | `E` | `Operator` | Unlock the sale event badge (100xp) |

## EULA

> Please don't use this plugin to conduct repulsive behaviors, including but not limited to: post fake reviews, posting advertisements, etc.
Expand Down Expand Up @@ -229,6 +221,23 @@ ASF.json
| `APIKEY [Bots]` | `Master` | Get Bot's APIKey |
| `ACCESSTOKEN [Bots]` | `Master` | Get Bot's ACCESSTOKEN |

## IPC Interface

| API | 方法 | 参数 | 说明 |
| ---------------------------------------------- | ---- | -------------------------------------------------- | -------------------------- |
| `/Api/ASFEnhance/{botNames}/FollowCurator` | POST | ClanIDs | Follow Curator |
| `/Api/ASFEnhance/{botNames}/UnFollowCurator` | POST | ClanIDs | UnFollow Curator |
| `/Api/ASFEnhance/{botNames}/FollowingCurators` | POST | Start, Count | Get Following Curators |
| `/Api/ASFEnhance/{botNames}/GetAppDetail` | POST | AppIDs | Get AppDetail |
| `/Api/ASFEnhance/{botNames}/Purchase` | POST | SubIDs, BundleIDs, SkipOwned | Purchase |
| `/Api/ASFEnhance/{botNames}/PublishReview` | POST | AppIDs, RateUp, AllowReply, ForFree,Public,Comment | Publish Review |
| `/Api/ASFEnhance/{botNames}/DeleteReview` | POST | AppIDs | Delete Review |
| `/Api/ASFEnhance/{botNames}/AddWishlist` | POST | AppIDs | Add Wishlist |
| `/Api/ASFEnhance/{botNames}/RemoveWishlist` | POST | AppIDs | Remove Wishlist |
| `/Api/ASFEnhance/{botNames}/FollowGame` | POST | AppIDs | Follow Game |
| `/Api/ASFEnhance/{botNames}/UnFollowGame` | POST | AppIDs | UnFollow Game |
| `/Api/ASFEnhance/{botNames}/CheckGame` | POST | AppIDs | Check Game Follow/Wishlist |

---

[![Repobeats analytics image](https://repobeats.axiom.co/api/embed/df6309642cc2a447195c816473e7e54e8ae849f9.svg "Repobeats analytics image")](https://github.com/chr233/ASFEnhance/pulse)
Expand Down
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@

ASFEnhance 介绍 & 使用指南: [https://keylol.com/t804841-1-1](https://keylol.com/t804841-1-1)

## Steam 新品节

> 活动有效期 10.3 - 10.10
| 命令 | 缩写 | 权限 | 说明 |
| ------- | ---- | ---------- | --------------------- |
| `EVENT` | `E` | `Operator` | 获取新品节徽章 (100xp) |

## EULA

> 请不要使用本插件来进行不受欢迎的行为, 包括但不限于: 刷好评, 发布广告 等
Expand Down Expand Up @@ -229,6 +221,23 @@ ASF.json
| `APIKEY [Bots]` | `Owner` | 查看 Bot 的 APIKey |
| `ACCESSTOKEN [Bots]` | `Owner` | 查看 Bot 的 ACCESSTOKEN |

## IPC 接口

| API | 方法 | 参数 | 说明 |
| ---------------------------------------------- | ---- | -------------------------------------------------- | ------------------------ |
| `/Api/ASFEnhance/{botNames}/FollowCurator` | POST | ClanIDs | 关注鉴赏家 |
| `/Api/ASFEnhance/{botNames}/UnFollowCurator` | POST | ClanIDs | 取消关注鉴赏家 |
| `/Api/ASFEnhance/{botNames}/FollowingCurators` | POST | Start, Count | 获取已关注的鉴赏家列表 |
| `/Api/ASFEnhance/{botNames}/GetAppDetail` | POST | AppIDs | 获取游戏详情 |
| `/Api/ASFEnhance/{botNames}/Purchase` | POST | SubIDs, BundleIDs, SkipOwned | 批量购买游戏 |
| `/Api/ASFEnhance/{botNames}/PublishReview` | POST | AppIDs, RateUp, AllowReply, ForFree,Public,Comment | 发布游戏评测 |
| `/Api/ASFEnhance/{botNames}/DeleteReview` | POST | AppIDs | 删除游戏评测 |
| `/Api/ASFEnhance/{botNames}/AddWishlist` | POST | AppIDs | 添加愿望单 |
| `/Api/ASFEnhance/{botNames}/RemoveWishlist` | POST | AppIDs | 移除愿望单 |
| `/Api/ASFEnhance/{botNames}/FollowGame` | POST | AppIDs | 关注游戏 |
| `/Api/ASFEnhance/{botNames}/UnFollowGame` | POST | AppIDs | 取消关注游戏 |
| `/Api/ASFEnhance/{botNames}/CheckGame` | POST | AppIDs | 检查游戏关注和愿望单情况 |

---

[![Repobeats analytics image](https://repobeats.axiom.co/api/embed/df6309642cc2a447195c816473e7e54e8ae849f9.svg "Repobeats analytics image")](https://github.com/chr233/ASFEnhance/pulse)
Expand Down

0 comments on commit 81ca55a

Please sign in to comment.