Debug and Template (VSCode) Ren'py

This template includes VSCode launchs and extensions for developing Ren'Py projects.

File

• bin/renpy: macOS/linux script for calling Ren'Py SDK renpy.sh
• bin/renpy.ps1: Windows script for calling Ren'Py SDK renpy.exe
• bin/set-origin.sh: Git setup helper to configure your local folder to sync to a remote host
• .vscode/launch.json: Launch for launching Ren'Py SDK commands without opening the Ren'Py launcher.
  • Setup (custom file for remembering your project's SDK path for commands to work)
  • Run
  • Force Recompile & Run
  • Delete Persistent
  • Lint
  • Distribute
• .vscode/extensions.json: Optional extensions that VSCode will offer to install for you
• .vscode/settings.json: For Test Formatting, and other settings
  • Ren'Py Language for syntax highlighting
  • Power Shell for an easy clickable list of launchs from .vscode/launch.json
  • Python for python syntax highlighting
• .gitignore: Git configuration file for ignoring certain file paths and types.
• /game/tool/utility.rpy: Useful functions such as: isNullOrEmpty
• /game/tool/flags.rpy: Flags System
• /game/tool/notify.rpy: Notify System
• /game/tool/log_system.rpy: Log System

How Run Debug (F5)

Setup

( Necessary only in the beginning )

Paste the path to your Ren'Py SDK folder

Exemple: /home/username/renpy

Run

Select:

• Run or
• Force Recompile & Run

And Play!

For Linux first:

Installing PowerShell on Ubuntu https://learn.microsoft.com/en-us/powershell/scripting/install/install-ubuntu?view=powershell-7.3

# Update the list of packages
sudo apt-get update
# Install pre-requisite packages.
sudo apt-get install -y wget apt-transport-https software-properties-common
# Download the Microsoft repository GPG keys
wget -q "https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb"
# Register the Microsoft repository GPG keys
sudo dpkg -i packages-microsoft-prod.deb
# Update the list of packages after we added packages.microsoft.com
sudo apt-get update
# Install PowerShell
sudo apt-get install -y powershell

give renpy permission

chmod +x renpy.sh
chmod +x renpy.py
chmod +x renpy.exe
chmod +x lib/py3-linux-x86_64/renpy
chmod +x lib/py3-linux-x86_64/pythonw
sudo apt-get install -y xdg-utils

when opening the text with error info via terminal, write:

:q

if this:

them:

sudo apt-get install -y yad

For microsoft wsl

https://docs.microsoft.com/it-it/windows/wsl/tutorials/gui-apps

Insert Template in your Project

I recommend the following ways to include it in your project:

• Pull branch (to insert it into your game and update it easily)
• Fork (to improve the repo or create a Toolkit based on mine)
• Manually (not recommended)

Pull branch

To insert or update the Toolkit in your repo with Pull branch I recommend the following procedure:

(only if you want to insert the repo) Create a new empty branch, in the example I'll use vscode-template

git checkout -b vscode-template
git checkout vscode-template
git config pull.rebase false
git pull https://github.com/DRincs-Productions/renpy-template-old.git tool-only --allow-unrelated-histories
git submodule update --init --recursive

At the end make a merge inside the arm of the project.