Renplay documentation
Configuration
Every environment variable Renplay reads, with its default.
Renplay works without any configuration. These environment variables are for special setups. Set
them on the container, for example with -e RENPLAY_IMAGE_QUALITY=80 or in the environment:
block of a Compose file.
A variable that is empty counts as not set. The container runs as any non-root user and with a read-only root filesystem, so any folder you point a variable at must be writable by that user.
Folders
Section titled “Folders”GAMES_DIR
Default: /games
Where installed games live. Put this on a big disk.
DATA_DIR
Default: /data
Saves and their history, the library database, mods, covers and walkthroughs. Back this up.
ARCHIVES_DIR
Default: $GAMES_DIR/_archives
The drop folder for game downloads (zip, 7z, rar), and the source for reinstalls.
RENPLAY_DIR
Default: $GAMES_DIR/_renplay
Engines and scratch space. Keep it on the same filesystem as GAMES_DIR.
SAVES_DIR
Default: $DATA_DIR/saves
Where saves are stored, laid out like desktop Ren’Py does.
SAVE_HISTORY_DIR
Default: $DATA_DIR/save-history
Earlier versions of saves that were overwritten or deleted.
OVERLAYS_DIR
Default: $DATA_DIR/overlays
Mods: your files, layered over a game.
Games and catalog
Section titled “Games and catalog”RENPLAY_DELETE_ARCHIVES
Default: true
Delete a download once its game installed. false keeps it, so the game can be reinstalled without uploading again.
RENPLAY_ADULT_GAMES
Default: not set
allow or block adult games for the whole install, and lock the choice. Not set: an existing library keeps showing adult games, a new install asks once in the empty library, and admins can change an unlocked choice in Settings. block reads the catalog’s safe-for-work index and hides adult games already in the library without deleting them. Any other value counts as block.
RENPLAY_CATALOG_URLS
Default: https://catalog.renplay.org/index.v3.json
Catalog indexes, separated by commas. The first one that defines a tag wins.
RENPLAY_ENGINES_URL
Default: https://engines.renplay.org/index.json
Where the Ren’Py web engines come from.
RENPLAY_ENGINE
Default: newest for the game
Build every game with this one engine version, such as one the engines index lists. A game’s recipe still wins.
Images and saves
Section titled “Images and saves”RENPLAY_IMAGE_QUALITY
Default: 88
WebP quality (1 to 100) for converted images.
RENPLAY_IMAGE_CONCURRENCY
Default: CPU count (at most 16)
Images converted in parallel during an install. 0 picks the CPU count.
RENPLAY_SAVE_HISTORY
Default: 20
Earlier versions kept per save file.
Behind a proxy
Section titled “Behind a proxy”RENPLAY_KEEPALIVE_URL
Default: not set
For scale-to-zero setups: a public URL that routes back to this server. While an install runs, Renplay keeps requesting it so the proxy does not stop the server.
RENPLAY_KEEPALIVE_HOST
Default: not set
The Host header to send with the keep-alive requests, if the proxy routes by host name.
Server
Section titled “Server”PORT
Default: 3000
Port of the Renplay server inside the container. nginx listens on 8080 and forwards to it, so you rarely change this.
Folders inside the container
Section titled “Folders inside the container”| Folder | What is in it |
|---|---|
/data | Saves and their history, the library, mods, covers, walkthroughs. Back this up. |
/games/_archives | The game downloads you added. Each is deleted once its game installs, unless RENPLAY_DELETE_ARCHIVES=false. |
/games (the rest) | Installed games. Renplay can rebuild them from the archives, while they are kept. |