Quick start

Run it

Renplay is one container. Give it a folder for games and one for data:

docker run -d --name renplay -p 8080:8080 \
  -v /path/to/games:/games \
  -v /path/to/data:/data \
  ghcr.io/renplay-org/renplay:2.10.0

The image runs as user 1000, so that user must be able to write to both folders. For a long-lived setup use Docker Compose. The image tag above pins this release, so upgrades happen when you decide. The same image is on Docker Hub as renplay/renplay.

Open http://localhost:8080.

Add a game

Copy a game’s PC download (zip, 7z or rar) into /path/to/games/_archives/, or upload it under Add games. Press Install. The first install also downloads the Ren’Py web engine, about 16 MB. See Adding games for what happens next.

Play

Open the game from the library and press Play. Saving works as in the desktop game, and the save goes to your server at once.

Play on your phone

Open Renplay in the phone’s browser and hold the phone sideways. On iPhone, add Renplay to the Home Screen first. See Playing.

Before you share it

Renplay has no accounts. Do not expose it to the internet as it is. Put it behind a reverse proxy with sign-in, or a VPN. See Reverse proxy and HTTPS.