ShowOff_WebAPI

一个为《闲置显摆器》添加WebAPI的 BepInEx 插件

如何安装

1. 在 Steam 购买下载《闲置显摆器》。
2. 在 BepInEx 的 releases页面 下载 最新稳定版本 的 BepInEx 压缩包。
3. 在 本项目的releases页面下载 ShowOff.WebAPI.dll。
4. 将 BeplnEx 的压缩包解压至 《闲置显摆器》 的游戏根目录，然后在 BepInEx 文件夹里创建 plugins 文件夹(如果已经有该文件夹则不用管这条)。
5. 将 ShowOff.WebAPI.dll 放入 plugins 文件夹。
6. 在 Steam 启动游戏，启动完成后打开浏览器输入 http://127.0.0.1:42062 出现游戏版本号及插件版本号即代表安装成功。

如何使用

信息

• 终结点: /
• 请求方式: GET

提示 : 该 API 无需参数

cURL -L http://127.0.0.1:42062/

{
    "success":0,
    "message":"",
    "data":{
        "plugName":"ShowOff_WebAPI",
        "plugVer":"1.0",
        "gameName":"Idle ShowOff",
        "gameVer":"0.1",
        "curContent":"😭"
    }
}

字段名	数据类型	说明
success	int	为 `0` 时表示请求成功，`-1`则表示请求失败。
message	string	当请求失败时将会在此字段输出原因。
plugName	string	插件名称。
plugVer	string	插件版本号。
gameName	string	游戏名称。
gameVer	string	游戏版本号。
curContent	string	显示当前推送文本。

推送

• 请求方式: GET
• 终结点: /push

字段名	数据类型	说明
Content	string	传递你需要的字符串至显摆器将其显摆。

cURL -L http://127.0.0.1:42062/push?Content=😭

{
    "success":0,
    "message":"",
    "data":{
    }
}

字段名	数据类型	说明
success	int	为 `0` 时表示请求成功，`-1`则表示请求失败。
message	string	当请求失败时将会在此字段输出原因。

配置

• 配置文件放在 游戏根目录\BepInEx\config\vm.mba.plugin.showoffwebapi.cfg

## Settings file was created by plugin ShowOff_WebAPI v1.0
## Plugin GUID: vm.mba.plugin.showoffwebapi

[WebAPI]

## WebAPI所使用端口
# Setting type: Int32
# Default value: 42062
Port = 42062

## WebAPI鉴权，每次调用API都需要AccessToken与配置文件一致
# Setting type: String
# Default value: 
AccessToken = 

配置	数据类型	说明
Port	int	WebAPI的端口号，默认42062，按需更改。
AccessToken	string	当填写这项配置后，每次请求WebAPI都会核对客户端输入的AccessToken与这项配置是否相符，若不相符会被直接作为非法请求。若你逆天程度高到需要公网部署，务必在里边填点能记住的东西。