https://github.com/remarkablegames/renpy-template
📖 Ren'Py Template to write visual novels
https://github.com/remarkablegames/renpy-template
game python renpy renpy-engine renpy-game renpy-visual-novels template visual-novel
Last synced: 9 months ago
JSON representation
📖 Ren'Py Template to write visual novels
- Host: GitHub
- URL: https://github.com/remarkablegames/renpy-template
- Owner: remarkablegames
- License: mit
- Created: 2024-06-07T23:05:58.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-09-14T21:34:20.000Z (9 months ago)
- Last Synced: 2025-09-14T23:31:54.978Z (9 months ago)
- Topics: game, python, renpy, renpy-engine, renpy-game, renpy-visual-novels, template, visual-novel
- Language: Ren'Py
- Homepage: http://remarkablegames.org/renpy-template/
- Size: 20.7 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Ren'Py Template
[](https://github.com/remarkablegames/renpy-template/actions/workflows/build.yml)
[](https://github.com/remarkablegames/renpy-template/actions/workflows/lint.yml)
📖 Write visual novels with Ren'Py Template.
Play the game on:
- [remarkablegames](https://remarkablegames.org/renpy-template)
## Credits
### Art
- [Uncle Mugen](https://lemmasoft.renai.us/forums/viewtopic.php?t=17302)
### Audio
- [Kenney](https://kenney.nl/assets/interface-sounds)
## Prerequisites
Download [Ren'Py SDK](https://www.renpy.org/latest.html):
```sh
git clone https://github.com/remarkablegames/renpy-sdk.git
```
Symlink `renpy`:
```sh
sudo ln -sf "$(realpath renpy-sdk/renpy.sh)" /usr/local/bin/renpy
```
Check the version:
```sh
renpy --version
```
## Install
Clone the repository to the `Projects Directory`:
```sh
git clone https://github.com/remarkablegames/renpy-template.git
cd renpy-template
```
Rename the project:
```sh
git grep -l "Ren'Py Template" | xargs sed -i '' -e "s/Ren'Py Template/My Novel/g"
```
```sh
git grep -l 'renpy-template' | xargs sed -i '' -e 's/renpy-template/my-novel/g'
```
Replace the assets:
- [ ] `game/gui/main_menu.png`
- [ ] `game/gui/window_icon.png`
- [ ] `web-icon.png`
- [ ] `web-presplash.webp`
## Run
Launch the project:
```sh
renpy .
```
Or open the `Ren'Py Launcher`:
```sh
renpy
```
Press `Shift`+`R` to reload the game.
Press `Shift`+`D` to open the developer menu.
## Cache
Clear the cache:
```sh
find game -name "*.rpyc" -delete
```
Or open `Ren'Py Launcher` > `Force Recompile`:
```sh
renpy
```
## Lint
Lint the game:
```sh
renpy game lint
```
## License
[MIT](LICENSE)