#CLI 概览

renmori 是 RenMori 的命令行工具，作用于 Ren'Py 启动器生成的发行版构建，在构建期完成资产封包、脚本变换、加载器写入与结果校验。它不读取也不修改游戏源码工程，不依赖 Ren'Py SDK，除首次下载闭源插件外不访问网络。

一次典型的发布流程只涉及两条命令：

renmori protect ./dist/MyGame-1.0-pc -o ./dist/MyGame-1.0-pc-protected
renmori verify  ./dist/MyGame-1.0-pc-protected

#工具的职责边界

#安装

renmori 以 PyPI 包 renmori 发布，需要 Python 3.9 及以上版本。依赖 cryptography 会随安装自动获取，该依赖仅供构建期工具使用，受保护的游戏在运行时不依赖任何 pip 包。

pip install renmori
renmori --version

作为独立命令行工具安装时，也可以使用 uv 或 pipx，二者会为 renmori 创建隔离环境：

uv tool install renmori
pipx install renmori

读取 renmori.toml 配置文件需要 Python 3.11 及以上版本的标准库 tomllib；在 3.9 或 3.10 上使用配置文件时，需要额外安装 tomli：

pip install tomli

如需修改源码或参与开发，可从仓库以可编辑模式安装：

git clone https://github.com/MewBaka/RenMori.git
cd RenMori
python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e .

#调用方式

安装后可通过两种等价方式调用：

renmori <command> [options]
python -m renmori <command> [options]

当系统中存在多个 Python 环境、renmori 不在 PATH 中时，第二种方式可明确指定使用哪一个解释器。

#命令一览

#通用选项

以下选项对 protect 与 verify 均有效，须写在子命令之后，例如 renmori protect ./build --quiet。

#环境变量

#处理流程概览

Ren'Py 启动器 Build Distributions
        │  发行版构建目录，或 *-pc.zip 等发行归档
        ▼
renmori protect
  1. 解析输入（目录，或解压 .zip 并定位含 game/ 的构建根目录）
  2. 合并配置（命令行 > renmori.toml > 默认值）
  3. 确定保护强度，按需获取并校验闭源插件
  4. 预检：输出或备份目录冲突、待封包文件数量
  5. 打印摘要并确认（仅交互式终端）
  6. 复制或备份 → 封包加密 → 变换脚本 → 删除明文 → 写入加载器扩展 → 写入构建清单
        │  受保护的发行版构建
        ▼
renmori verify  →  校验通过后上传或打包分发

#相关页面

• renmori protect：全部参数、文件处理规则与执行流程
• renmori verify：校验项目与使用方式
• 配置文件 renmori.toml：全部配置键与合并规则
• 输出、构建清单与退出码：供脚本与 CI 解析的输出格式
• 保护强度与闭源插件：基线保护与完整保护的区别，插件的获取与缓存
• 故障排查：全部错误信息及处理方式