110 - API文档汉化 - 入门指南

Updated 6 days ago

入门指南

入门指南:安装

首先,我们将介绍如何安装所有《邪恶冥刻》模组依赖的框架BepInEx。这是运行模组化《邪恶冥刻》的必要步骤,请务必仔细遵循以下说明。

使用模组管理器安装

  1. 下载并安装Thunderstore Mod ManagerGaler2modman
  2. BepInEx页面顶部点击Install with Mod Manager按钮。
  3. 通过模组管理器启动游戏。

若遇到模组管理器问题,请前往以下Discord服务器寻求支持:

手动安装

  1. 通过点击“Manual Download”安装BepInEx,将内容解压至文件夹(切勿解压到游戏目录!
  2. 将“BepInExPack_Inscryption”文件夹内容移至游戏目录(即游戏可执行文件所在位置)
  3. 启动游戏。若操作正确,桌面将显示BepInEx控制台。待游戏加载完成后关闭
  4. 安装MonoModLoader并解压内容至文件夹
  5. 将“patchers”文件夹内容移至“BepInEx/patchers”(如相关BepInEx文件夹不存在,请手动创建)
  6. 安装Inscryption API并解压内容至文件夹
  7. 将“plugins”文件夹内容移至“BepInEx/plugins”,“monomod”文件夹内容移至“BepInEx/monomod”
  8. 再次启动游戏。若运行正常,控制台将显示API已加载的提示信息

Steam Deck安装指南

  1. 在Steam Deck桌面模式下载r2modman,通过其AppImage文件启动
  2. 下载计划使用的模组及其依赖项
  3. 进入模组配置文件的设置界面,点击Browse Profile Folder
  4. 复制BepInEx文件夹,通过Steam打开《邪恶冥刻》属性菜单
  5. 进入Installed Files点击Browse打开游戏本地文件目录,粘贴BepInEx文件夹
  6. 切换至游戏模式,在属性菜单的Compatibility中勾选“Force the use of a specific Steam Play compatibility tool”
  7. 在启动参数中输入WINEDLLOVERRIDES=“winhttp.dll=n,b” %command%
  8. 启动游戏。若操作正确,屏幕将显示控制台界面

Mac & Linux系统

  1. 首先完成此文档步骤:https://docs.bepinex.dev/articles/user_guide/installation/index.html
  2. 随后执行手动安装指南的第4-8步
  3. 至此游戏应已完成模组环境配置

如遇Mac/Linux、Steam Deck或手动安装问题,请前往游戏官方Discord:

入门指南:模组开发

《邪恶冥刻》模组开发需要掌握C#编程知识,多数情况下还需理解如何使用HarmonyPatch进行游戏补丁。

若您不熟悉这些技术,或仅希望创建卡牌与印记,可使用JSONLoader

使用JSONLoader开发

JSONLoader是一款多功能模组,通过JSON语法为《邪恶冥刻》提供更友好的卡牌与能力创建方式,其复杂度远低于C#。

JSONLoader文档参见此处

基础使用视频教程参见此处

使用C#开发

开始C#模组开发前,需使用代码编辑器创建新的C#项目。我们推荐并默认您使用Microsoft Visual Studio。

项目目标框架需设置为netstandard2.0

创建项目后,进入项目 > 管理NuGet程序包...。点击“程序包源”下拉菜单,确保已包含“BepInEx”和“nuget”。

如缺少BepInEx或nuget源,需手动添加:

  1. 点击程序包源选择器旁的齿轮图标
  2. 点击绿色加号按钮
  3. 添加BepInEx源:名称设为“BepInEx”,源链接设为https://nuget.bepinex.dev/v3/index.json
  4. 添加nuget源:名称设为“nuget”,源链接设为https://nuget.windows10ce.com/nuget/v3/index.json

将包源切换为“全部”后点击“浏览”,安装以下包(确保版本号匹配!):

  • BepInEx.Analyzers v1.0.8
  • BepInEx.Core v5.4.19
  • HarmonyX v2.9.0
  • Inscryption.GameLibs v1.9.0-r.0
  • UnityEngine.Modules v2019.4.24

还需添加API引用,具体方法如下(任选其一):

  1. 进入BepInEx/plugins文件夹复制路径
  2. 通过项目 > 添加项目引用... > 浏览 > 浏览...添加“InscryptionAPI.dll” (该文件位于BepInEx插件目录BepInEx/plugins/API_dev-API中)

如需引用其他模组作为依赖项,可同样添加其.dll文件。

替代方案是通过NuGet添加引用:

  1. 添加包源https://nuget.bepinex.dev/v3/index.json
  2. 添加“API_dev-API”引用

完成上述步骤后,即可开始模组创作! 以下提供部分开发资源(含示例模组),或继续阅读本Wiki文档。

开发资源

《邪恶冥刻》模组开发Discord

BepInEx文档

Harmony补丁指南

C#示例模组

原版与模组枚举类型