SDK指南

本指南将对未来的模组制作者和开发者有所帮助！ ModboxSDK入门 ModboxSDK用于创建Modbox模组。制作模组需要具备Unity相关知识，若要添加自定义脚本，则需使用C#语言。 安装ModboxSDK 在Steam应用的“工具”部分中，会有一个ModboxSDK应用。运行该应用将打开Unity项目文件夹。 请查看Readme.txt以了解Unity版本要求。你可能无需使用完全相同的版本（例如，如果ModboxSDK是基于5.41fb1版本构建的）。42f2版本是可以的，不过可能会引发问题——但版本号必须保持一致（使用5.4版本而Modbox是基于5.3版本构建的情况则不行）。在Unity中打开ModboxSDK文件夹。 首次导入所有资源可能需要一段时间（约10分钟）。过程中还会出现一些导入错误/警告——通常这些都是无害的，所以加载完成后点击“清除”即可清除它们。 在Scenes文件夹中，打开“TestScene”。这是一个用于测试实体/创作的空白测试场景。现在你应该可以运行游戏并在Unity中体验Modbox了。 SDK使用 - 资源包 你仍然可以通过ModboxSDK加载并运行所有常规的Modbox模组和创作——只需设置Modbox模组目录的路径，即可加载Modbox自带的默认模组。使用【Modbox/SDK 设置】菜单来设置正确路径。 默认情况下，【模拟资源包】处于开启状态。这意味着它会首先加载 Unity 项目窗口中【Mods】文件夹内的模组，并将这些模组作为 Unity 预制体而非资源包加载。因此，在开发时通常需要开启模拟资源包，这样新实体才能实际更新。你可以在 Modbox 菜单项中开启或关闭模拟资源包。 对于 ModboxSDK，仅包含【基础】模组和【科幻武器库】模组的预制体。可将这些实体作为设置实体的示例。 【引擎】游戏对象包含场景运行方式的设置，将鼠标悬停在选项上可查看工具提示。引擎选项： VR测试非VR模式：让你无需进入VR即可进行测试 - 详见非VR控制 默认关卡：启动时切换到此环境 默认模组：启动时加载的模组列表 创建模组 在模组目录中，新建一个以你的模组名称命名的文件夹。 在文件夹内右键，选择“创建/模组元数据”。这里将存放你的模组描述及其他信息 - 必须命名为“modmetadata”。将鼠标悬停在检视器中的变量上，可查看每个变量的作用。 备份你的模组数据！最好使用版本控制系统 - 因为Steam在更新SDK时可能会将其清除 模组元数据选项： ModName - “ModName”是保存在创作内容中的名称 - 因此必须唯一且不可更改。 ModFullName - 显示给用户的完整名称描述 - 显示在创意工坊页面 图标 - 创意工坊页面的图片 Mod类型 - 用于创意工坊页面的标签 实体分类 - 在此添加实体将使用的新分类 作者：Steam创意工坊的作者列表 已发布文件ID：创意工坊ID。首次上传到创意工坊时创建。 当你在Unity编辑器中运行ModboxSDK时，你的模组现在应该会显示在“模组”表格中。前往此处并点击启用以激活该模组，启用模组后，它将在文件夹中搜索具有以下组件的任何游戏对象： 实体 Modbox材质 - 基本体的纹理选项 Modbox物理材质 - 实体物理的选项，可设置密度/碰撞音效/物理材质/断裂力 物理音效 - 碰撞音效集 环境选项 - 用户可切换的新环境（链接至Unity场景） 为了使模组编辑更轻松，你还可以在Engine.cs中将你的模组名称添加到“默认模组”列表中，这样它会在启动时加载 教程：向Modbox SDK添加资源并创建自定义盒体碰撞器 教程：向Modbox SDK添加资源并创建自定义盒体碰撞器