Skip to content

LIghtJUNction/OniMods

Repository files navigation

OniMods

Oxygen Not Included Mod 仓库,包含:

  • onim:本仓库内置的缺氧 Mod 开发 CLI,用于初始化、构建、安装、卸载和发布 Mod。
  • oni_mcp:让 AI 助手通过 MCP 读取并操作缺氧殖民地的 Mod。

兼容性警告oni_mcp1.0.0 之前 API 仍可能发生不兼容变更。二创、插件、脚本或第三方客户端请锁定具体版本,并以运行时 tools_manifest / oni://tools/manifest 为准做兼容适配。

快速入口

项目 路径 说明
onim src/ Rust 编写的 Mod 开发工具链
oni_mcp mods/oni_mcp/ ONI MCP Server Mod
oni_mcp 中文文档 mods/oni_mcp/README.md 安装、连接和功能说明
oni_mcp English docs mods/oni_mcp/README_EN.md English installation and usage guide

ONI MCP Server

ONI MCP Server 文档

展开 Mod 介绍

oni_mcp 是为缺氧量身定制的 MCP 服务器 Mod。安装后,支持 MCP 的 AI 客户端可以通过本地 HTTP 接口读取殖民地状态、分析局势,并在授权后执行部分游戏操作。

它目前更适合作为“AI 殖民顾问”和“半自动操作助手”:

  • 读取殖民地状态、资源库存、复制人需求、电力、房间、温度和火箭等数据。
  • 执行简单明确的操作,例如暂停游戏、截图、调整日程、修改建筑设置、设置门禁权限、重命名复制人。
  • 通过工具分组、搜索工具和 .agents/skills 中的技能说明,帮助 agent 学会使用大量 MCP 工具。
  • 对挖掘、拆除等高风险操作提供风险分级和确认机制。

它不是完整的游戏 agent 实现。复杂世界规划、长期自治游玩和高质量战术决策仍然需要大量约束、验证和人工监督。

相关 AI Skill 实现参考:zhuiyun.skill

展开开发备忘

想法备忘:实现第二个“agent 指针”,始终指向格子中心并渲染到屏幕上,让 AI 的所有操作基于这个可视指针执行。相比直接基于坐标下命令,这可能更稳定,也更容易观察和调试。

省流结论:不要指望当前 AI 能长期自主玩好缺氧这类复杂模拟游戏。现阶段更现实的方向是让 AI 读取更多游戏数据、执行明确的小任务,并在玩家确认下辅助完成局部规划。

onim

onim 是缺氧 Mod 开发工具链,覆盖从项目初始化到 Steam 创意工坊发布的常用流程。

一句话开始

cargo install --path .
onim setup
onim init MyMod
onim dev -m MyMod

常用工作流

# 1. 安装 onim CLI
cargo install --path .

# 2. 交互式初始化:检测游戏路径、检查依赖、写入配置
onim setup

# 3. 创建新 Mod
onim init MyMod --author YourName --desc "Mod 描述"

# 4. 开发迭代
onim dev -m MyMod          # 构建并安装到游戏 Dev 目录
onim build -m MyMod        # 仅构建
onim info                  # 查看已安装的 Mod

# 5. 正式发布
onim install -m MyMod      # Release 构建并安装到 Local 目录
onim publish -m MyMod      # 上传到 Steam 创意工坊

# 6. 清理
onim uninstall -m MyMod    # 从游戏目录卸载

-m <name> 用于指定 Mod。不指定时,onim 使用 oni-mods.toml 中的 default_mod

命令速查

命令 作用
onim setup 初始化项目配置,检测游戏路径和依赖
onim init <name> 从模板创建新 Mod
onim build 构建 Mod,--release 为 Release 构建
onim dev 构建并安装到游戏 mods/Dev/
onim install Release 构建并安装到 mods/Local/
onim uninstall 卸载 Mod,支持 --scope dev/local/all
onim info 查看已安装的 Dev、Local 和 Steam Mod
onim publish 发布到 Steam 创意工坊,支持 --gui
onim list 列出配置文件中的 Mod

目录结构

.
├── oni-mods.toml          # onim 配置文件,记录默认 Mod 和 Mod 列表
├── Directory.Build.props  # MSBuild 全局配置,记录游戏 DLL 引用路径
├── Cargo.toml             # onim CLI
├── src/                   # onim 源码
├── mods/                  # Mod 项目目录
│   ├── OniModTemplate/    # Mod 模板
│   └── oni_mcp/           # ONI MCP Server
└── oni/src/               # 游戏反编译源码参考

依赖

  • Rust:编译 onim
  • .NET SDK:构建 Mod
  • unzip:安装构建产物时解压
  • tar:打包源码

onim setup 会自动检查依赖并提示安装方式。

About

oxygen not included

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors