Skip to content

Commit

Permalink
更新README
Browse files Browse the repository at this point in the history
  • Loading branch information
samyycX committed Jul 4, 2024
1 parent 12b379f commit 6f37871
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 5 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# CS2-BuffInspector
基于WeaponPaints,在游戏内解析buff的分享链接并更换皮肤

也可作为API库使用

支持:
- 枪械
- 刀具
- 手套

- 印花
# 依赖
- [WeaponPaints](https://github.com/Nereziel/cs2-WeaponPaints) **(需要已经生成并配置好配置文件)**
- [WeaponPaints](https://github.com/Nereziel/cs2-WeaponPaints) **(需要已经生成并配置好配置文件)** *纯API库模式不需要*

# 配置项
- `UseSync` 设置为true时开启同步模式,并且解析完成后自动刷新皮肤 (默认关闭,不会自动刷新皮肤)
Expand All @@ -15,8 +18,32 @@
- `EnableImagePreview` 开启屏幕中心的图片预览
- `ImagePreviewTime` 图片预览的持续时间(秒)
- `EnableSticker` 开启贴纸功能(目前存在一些无法刷新的BUG,有需要请关闭)
- `PureApiMode` 纯API库模式,供其他插件使用(正常情况无需配置)
# 使用方法
安装完插件后,使用
1.[Release](https://github.com/samyycX/CS2-BuffInspector/releases/latest) 下载插件压缩包
2. 解压后,将plugins文件夹和shared文件夹放置在 `game/csgo/addons/counterstrikesharp` 文件夹下
3. 使用
`!buff <buff分享链接>`
指令更换BUFF皮肤


# API 库使用方法
API方法请查看 [IBuffApiService.cs](https://github.com/samyycX/CS2-BuffInspector/blob/master/Shared/IBuffApiService.cs)

在您的插件中整合API的样例:
```csharp
public class ExamplePlugin : BasePlugin
{
public static PluginCapability<IBuffApiService> BuffApiService = new("buffinspector:service");

// 在你需要使用api的方法内使用
[ConsoleCommand("css_buff", "buff")]
public void OnBuffCommand(CCSPlayerController player, CommandInfo commandInfo) {

// 拿到url参数
string url = ...;

// 调用API,拿到SkinInfo
SkinInfo? skinInfo = BuffApiService.Get().GetSkinInfoByBuffShareLink(url);
}
}
4 changes: 2 additions & 2 deletions Shared/IBuffApiService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ public interface IBuffApiService {
/// 通过buff分享链接获取饰品信息
/// </summary>
/// <param name="shareLink">buff分享链接,支持短链</param>
/// <returns>饰品信息,失败时返回null,目前仅支持枪械,匕首,手套</returns>
/// <returns>饰品信息,失败时返回null,目前仅支持枪械(包括印花),匕首,手套</returns>
public SkinInfo? GetSkinInfoByBuffShareLink(string shareLink);


/// <summary>
/// 通过buff分享链接异步获取饰品信息
/// </summary>
/// <param name="shareLink">buff分享链接,支持短链</param>
/// <returns>饰品信息,失败时返回null,目前仅支持枪械,匕首,手套</returns>
/// <returns>饰品信息,失败时返回null,目前仅支持枪械(包括印花),匕首,手套</returns>
public Task<SkinInfo?> GetSkinInfoByBuffShareLinkAsynchronously(string shareLink);

/// <summary>
Expand Down

0 comments on commit 6f37871

Please sign in to comment.