Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ONIModTutorial

VitePress

这是一本《缺氧》(Oxygen Not Included)Mod 开发笔记,也会整理成一套可以按顺序读的教程。

内容以实际开发会遇到的问题为主:环境怎么配、源码怎么查、Harmony Patch 怎么下手、建筑和物品怎么注册、遇到版本更新时怎么排查。它不是完整的 C# 教材,也不打算把每个系统都讲成百科;更希望在你卡住的时候,能给出一条能继续往前走的路。

内容

  • 开发环境与常用工具
  • Mod 目录结构和加载流程
  • 面向 ONI Mod 的 C# 基础
  • dnSpy 反编译与源码分析
  • Harmony Patch 写法和常见坑
  • 建筑、物品、植物、生物、元素等内容扩展
  • Steam 创意工坊发布和版本兼容处理

目录结构

  • .vitepress/:VitePress 配置、主题和构建缓存
  • content/:游戏内容扩展相关章节
  • public/:图片、模板包等静态资源
  • *.md:教程正文和站点页面

本地预览

先安装 Node.js LTS。Windows 用户安装时建议勾选“Add to PATH”。

git clone https://github.com/ChiYuKe/ONIModTutorial.git
cd ONIModTutorial
npm install
npm run dev

启动后打开终端里显示的地址。默认情况下通常是:

http://localhost:5173/ONIModTutorial/

适合谁

  • 想做《缺氧》Mod,但还不知道从哪里开始的玩家
  • 会一点 C#,想把知识用到 ONI Mod 上的人
  • 已经在写 Mod,但想补上源码分析和 Patch 思路的人
  • 想整理、补充或校对 ONI Mod 开发资料的贡献者

贡献

欢迎提交 Issue 或 Pull Request。错别字、过期截图、工具链接、代码示例、实战案例都可以补。

提交前请运行 npm run check;修改了示例代码时,再用本机游戏 DLL 运行 scripts/verify-examples.ps1

About

《缺氧》Mod 开发笔记与教程(VitePress 文档站):环境配置、源码查阅、Harmony Patch、建筑与物品注册

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages