外观
SDK 概览
StudioSDK.dll 是插件开发者唯一需要直接引用的程序集。它提供了四样东西:
| 命名空间内的类型 | 作用 |
|---|---|
StudioPlugin | 插件基类,继承自 Unity MonoBehaviour |
StudioPluginAttribute | 插件元数据特性,供 Loader 发现与识别 |
StudioAPI | 静态门面,封装与 Studio 底层交互的高频操作 |
PluginConfig / ConfigEntry<T> | 类型安全的 INI 配置系统 |
IPluginLogger / ModLogger | 插件专用分级日志 |
最小骨架
csharp
using StudioMod.SDK;
using UnityEngine;
[StudioPlugin("com.vendor.pluginid", "显示名称", "1.0.0", "作者名", "功能描述")]
public class MyPlugin : StudioPlugin
{
public override void OnLoaded()
{
Logger.Info("插件已加载");
}
}文档索引
| 主题 | 说明 |
|---|---|
| 插件生命周期 | 实例化顺序、各回调触发时机 |
| StudioAPI 门面 | 模型上下文、菜单、Toast、全局事件 |
| 配置系统 | Config.Bind<T> 与变更监听 |
| 日志系统 | 分级日志与输出目标 |
| Mod 窗口开发规范 | NGUI / WebView2 选型与共同要求 |
| NGUI 窗口 | Studio 内原生控件、布局与生命周期 |
| WebView2 窗口 | 独立网页窗口、JSON 通信与 logo |
| Harmony 补丁 | Prefix / Postfix 补丁写法 |
| 编译与打包 | 两种编译方式与产物位置 |