> For AI agents: the complete documentation index is available at https://renmori.mewbaka.cn/en/llms.txt, the full documentation bundle is available at https://renmori.mewbaka.cn/en/llms-full.txt.

# Quick Start

## Requirements

- Python 3.9 or later
- Python 3.11 or later to read a `renmori.toml` config, or `tomli` installed on older versions
- A game distribution built with Ren'Py 8.x

## Install


```sh [pip]
pip install renmori
```

```sh [uv]
uv tool install renmori
```

```sh [pipx]
pipx install renmori
```

Run `renmori --version` afterwards to confirm the CLI is available.

## Protect a game

1. Run _Build Distributions_ in the Ren'Py launcher; RenMori works only on the distribution build and never modifies the game source

2. Protect the build; the input can be the build directory or the `.zip` archive produced by the launcher

   ```bash
   renmori protect ./dist/MyGame-1.0-pc -o ./dist/MyGame-1.0-pc-protected
   ```

   On the first full protection, RenMori downloads the closed-source plugin for your platform from the public release, verifies it, and caches it locally

3. Verify the result; this command can serve as a CI gate

   ```bash
   renmori verify ./dist/MyGame-1.0-pc-protected
   ```

4. Ship the protected directory as your release, with `renmori.rmc` and `renmori.rpe` distributed together; do not rebuild it with the Ren'Py launcher, as that discards the protection

## Next steps

- [`renmori protect`](https://renmori.mewbaka.cn/en/cli/protect.md): all options, file handling rules and the execution flow
- [Configuration File renmori.toml](https://renmori.mewbaka.cn/en/cli/configuration.md): fixing protection parameters across a team and in CI
- [Protection Strength and the Closed Plugin](https://renmori.mewbaka.cn/en/cli/plugin.md): the difference between baseline and full protection
- [CI integration](https://renmori.mewbaka.cn/en/integration/ci.md): automating protection and verification in a pipeline
- [Releasing to Steam](https://renmori.mewbaka.cn/en/integration/steam-release.md): uploading a protected build and its launch options
- [Notes for Developers](https://renmori.mewbaka.cn/en/license/developer-notes.md): license scope and the pre-release checklist