BepInEx 插件开发文档中文翻译 - 项目分享
前言
做 Unity 游戏 mod 开发的同学应该对 BepInEx 不陌生,它是 Unity 游戏最常用的插件加载框架之一。但官方文档一直是英文的,对于英文不太好的开发者来说,入门门槛还是比较高。
我花了些时间把 BepInEx 的官方文档翻译成了中文,目前翻译了 v5.4.21 版本的文档,包括用户指南、开发指南、高级主题、API 文档和术语表等内容。这里分享一下这个项目,希望能帮到有需要的人。
关于 BepInEx
BepInEx(Bep is In jector Extensible)是一个面向 Unity 游戏的补丁器/插件框架,支持 Mono 和 IL2CPP 两种脚本后端。
主要功能包括:
- 即插即用安装
- 内置配置和日志系统
- 使用 Harmony 进行运行时方法补丁
- 内存程序集补丁
- 支持多种模组加载器(IPA、MelonLoader、Sybaris 等)
简单来说,如果你想给 Unity 游戏写 mod,BepInEx 基本是标配。
翻译内容
本次翻译基于 BepInEx 官方文档 v5.4.21,包含以下内容:
| 分类 | 内容 |
|---|---|
| 用户指南 | 安装、配置、升级、故障排除 |
| 开发指南 | 插件教程(4 章)、开发工具、运行时补丁、预加载补丁器 |
| 高级主题 | 兼容性、Steam 互操作、Proton/Wine、调试 |
| API 文档 | API 概览 |
| 术语表 | 中英文术语对照表 |
其中插件教程是重点,从环境搭建到编写第一个插件,再到日志和配置,一共 4 章内容,手把手教你开发 BepInEx 插件。
项目地址
GitHub:https://github.com/TheDarkXian/BepinEX-.git
注:由于新仓库地址尚未创建成功,暂时使用旧地址。如有更新请以 GitHub 页面为准。
如何使用
直接 clone 仓库,在 zh/ 目录下就是中文文档,en/ 是英文原文(方便对照)。
bash
git clone https://github.com/TheDarkXian/BepinEX-.git
文档是 Markdown 格式,可以直接在 GitHub 上在线阅读,也可以用任何 Markdown 编辑器打开。
关于版本
| 项目 | 版本 |
|---|---|
| BepInEx 最新版本 | v5.4.23.5 |
| 文档翻译基于版本 | v5.4.21 |
| 翻译版本 | v1.0.0 |
文档版本和 BepInEx 代码版本不一定完全同步,翻译基于的是文档站点的版本。如果后续官方文档有更新,我会尽量跟进。
翻译说明
- 翻译仅供参考,请以官方英文文档为准
- 术语表(
glossary.md)确保了翻译的一致性,比如 Plugin → 插件、Patcher → 补丁器、Assembly → 程序集等 - 代码块保持原样,只翻译了注释部分
- 专有名词(BepInEx、Unity、Harmony 等)保留英文
知识产权声明
- 原文档版权归 BepInEx Team 所有
- 原项目采用 LGPL-2.1 许可证
- 本翻译作品采用 CC BY-SA 4.0 许可证
- 使用时请注明出处
贡献
欢迎提交 PR 或 Issue 来帮助改进翻译。如果你发现翻译有误或者想补充内容,随时欢迎。
也欢迎去 BepInEx 的 GitHub 给原项目点个 star,确实是个很优秀的框架。
结语
Unity mod 开发在国内社区还是挺活跃的,但很多文档和资料都是英文的,希望这个翻译项目能降低一些入门门槛。如果有帮到你,欢迎 star 支持一下。