Reference
Importer CLI options
Every option of rsl_import.py, with its window equivalent.
On this page
bash
python3 importer/rsl_import.py SOURCE [options]| Option | Window | Meaning |
|---|---|---|
--out DIR | Target: SD card | Export to DIR/switch/renpy-loader/games/<id>/. On Windows a bare --out E: means the drive’s top folder |
--out ftp://HOST:PORT | Target: Switch over Wi-Fi | Upload to the Switch through sphaira’s FTP server. See Upload over FTP |
--id ID | Game id | Choose the folder name. It must already be in normalised form (lowercase a-z, 0-9, -) |
--replace | Replace | Update an existing export. Without it, the importer refuses if games/<id> exists |
--optimize | Optimize | Re-encode videos above 30 fps at 30 fps, same size, constant quality. Needs FFmpeg |
--cover IMAGE | Change cover… | The cover, from any picture FFmpeg reads; a 2:3 poster suits it best. Default: the middle of the menu art |
--backdrop IMAGE | Change background… | The 16:9 picture behind the details page and Cinematic layout. Default: the menu art |
--recompile | Recompile | Ren’Py 7 / Python 2 games only. Export without .rpyc, so Ren’Py 8.5.3 compiles the .rpy sources |
--decompile | Decompile | Rebuild a .rpy for each .rpyc that has none, then recompile. Implies --recompile |
--decompiler TOOL | Choice under Decompile | unrpyc (default) or rpycdec |
--tools DIR | Tools folder… | A folder holding ffmpeg/ffprobe or 7z, searched before PATH |
--rpycdec-python PYTHON | — | With --decompiler rpycdec: a Python 3.10+ that has rpycdec installed. Command line only |
Without --out, the importer only prints the report.
Exit status
| Code | Meaning |
|---|---|
0 | OK |
1 | Refused: unsafe archive, not a Ren’Py game, unsupported game, or the export already exists |
2 | Bad arguments |
Examples
Recompile a Ren’Py 7 game that ships its sources:
bash
python3 importer/rsl_import.py OldGame --recompile --out /Volumes/SDDecompile with rpycdec, using a separate Python:
bash
python3 importer/rsl_import.py OldGame --decompile --decompiler rpycdec --rpycdec-python ~/py312/bin/pythonReplace a game already on the Switch, with your own cover:
bash
python3 importer/rsl_import.py MyGame-1.1.zip --replace --cover poster.png --out ftp://192.168.1.20:5000Use FFmpeg from an unzipped folder on Windows:
powershell
py importer\rsl_import.py MyGame.zip --tools C:\ffmpeg\bin --out E:\