README.md

Renpy Template

📖 Write visual novels with Ren'Py Template.

Play the game on:

• remarkablegames

Credits

Art

• Uncle Mugen

Audio

• Kenney Interface Sounds

Prerequisites

Download Ren'Py SDK:

git clone https://github.com/remarkablegames/renpy-sdk.git

Symlink renpy:

sudo ln -sf "$(realpath renpy-sdk/renpy.sh)" /usr/local/bin/renpy

Install

Clone the repository to the Projects Directory:

git clone https://github.com/remarkablegames/renpy-template.git
cd renpy-template

Rename the project:

git grep -l 'Renpy Template' | xargs sed -i '' -e 's/Renpy Template/My Novel/g'

git grep -l 'renpy-template' | xargs sed -i '' -e 's/renpy-template/my-novel/g'

Replace the assets:

• web-presplash.jpg
• game/gui/main_menu.png
• game/gui/window_icon.png

Run

Launch the project:

renpy .

Or open the Ren'Py Launcher:

renpy

Press Shift+R to reload the game.

Press Shift+D to display the developer menu.

Cache

Clear the cache:

find game -name "*.rpyc" -delete

Or open Ren'Py Launcher > Force Recompile:

renpy

Lint

Lint the game:

renpy game lint

License

MIT