Ren'Py Visual Novel Engine Documentation

https://www.renpy.org/doc/html
Admin
The official documentation for the Ren'Py Visual Novel Engine, a powerful and easy-to-use tool for...
Tokens:431,517
Snippets:5,073
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Restore old start callback behavior with config.early_start_store

Source: https://www.renpy.org/doc/html/incompatible.html

Restores the old behavior where config.start_callbacks run before default statements during game start but not replay start.

```renpy
define config.early_start_store = True

```

--------------------------------

### Start

Source: https://www.renpy.org/doc/html/screen_actions.html

Jumps out of the menu context to a specified label, typically used to start a new game from the main menu.

```APIDOC
## Start

### Description
Causes Ren'Py to jump out of the menu context to the named label. The main use of this is to start a new game from the main menu.

### Parameters
* **label** (string) - Optional - The name of the label to jump to. Defaults to 'start'.
```

--------------------------------

### Partial playback with <from> and <loop> specifications

Source: https://www.renpy.org/doc/html/audio.html

Partial playback uses angle-bracket specifications at the start of the filename. The first example plays 10.5 seconds of waves.opus from the 5-second mark to 15.5 seconds. The second plays song.opus fully once, then loops back to the 6.333-second mark for subsequent play-throughs.

```renpy
play music "<from 5 to 15.5>waves.opus"

```

```renpy
play music "<loop 6.333>song.opus"

```

--------------------------------

### Start New Game

Source: https://www.renpy.org/doc/html/screen_actions.html

Jumps to a specified label to start a new game. Defaults to the 'start' label.

```renpy
Start(_label ='start'_)
```

```renpy
Start()
```

```renpy
Start("foo")
```

--------------------------------

### Main Menu Special Label Example

Source: https://www.renpy.org/doc/html/label.html

An example of the 'main_menu' special label. If this label returns, Ren'Py will start the game at the 'start' label, effectively skipping the default main menu.

```renpy
label main_menu:
    return

```

--------------------------------

### Downloader game script using updater API

Source: https://www.renpy.org/doc/html/downloader.html

Example Ren'Py script for a downloader game. It sets config.save to False to prevent saving, uses the splashscreen to start immediately, calls updater.start_game_download() to gather download info, displays size if known, and calls updater.continue_game_download() to start the download. The public_key.pem from the main game should be placed in the downloader's base directory for security.

```renpy
# The url to updates.json, on your web server.
define URL = "https://www.domain.com/game-updates/updates.json"

# Disable saving in the downloader game.
define config.save = False

define e = Character("Eileen", image="eileen")

label splashscreen:

    scene bg washington
    show eileen happy at left

    $ downloader = updater.start_game_download(URL)

    e "Welcome to the downloader game."

    e "This will download the main game onto your phone, so you can play it."

    if downloader.download_total:
        $ download_mb = int(round(downloader.download_total / 1024 / 1024, 0))

        e "To play this game, you'll need to download [download_mb] megabytes of data. If you're not on WiFi, you could be charged for it. Tap the screen to proceed."

    else:

        e "To play this game, you'll need to download some data. If you're not on WiFi, you could be charged for it. Tap the screen to proceed."

    $ updater.continue_game_download()

```

--------------------------------

### Screen with docstring and properties (hello_world)

Source: https://www.renpy.org/doc/html/screens.html

Declares a screen named 'hello_world' with a docstring, tag 'example', zorder 1, modal False, and a text displayable. The docstring can be retrieved with renpy.get_screen_docstring().

```renpy
screen hello_world():
     """
     Displays a hello world message.
     """

     tag example
     zorder 1
     modal False

     text "Hello, World."

```

--------------------------------

### Gamepad Keymap Configuration Example

Source: https://www.renpy.org/doc/html/keymap.html

This JSON-like structure shows example bindings for gamepad directional inputs. It maps various 'pad_*' events to actions like 'focus_*', 'bar_*', and 'viewport_*'. The 'repeat_' prefix indicates bindings for held buttons.

```json
"pad_rightx_pos" : [ "focus_right", "bar_right", "viewport_rightarrow" ],

    "pad_dpup_press" : [ "focus_up", "bar_up", "viewport_uparrow" ],
    "pad_lefty_neg" : [ "focus_up", "bar_up", "viewport_uparrow" ],
    "pad_righty_neg" : [ "focus_up", "bar_up", "viewport_uparrow" ],

    "pad_dpdown_press" : [ "focus_down", "bar_down", "viewport_downarrow" ],
    "pad_lefty_pos" : [ "focus_down", "bar_down", "viewport_downarrow" ],
    "pad_righty_pos" : [ "focus_down", "bar_down", "viewport_downarrow" ],

    "repeat_pad_dpleft_press" : [ "focus_left", "bar_left", "viewport_leftarrow" ],
    "repeat_pad_leftx_neg" : [ "focus_left", "bar_left", "viewport_leftarrow" ],
    "repeat_pad_rightx_neg" : [ "focus_left", "bar_left", "viewport_leftarrow" ],

    "repeat_pad_dpright_press" : [ "focus_right", "bar_right", "viewport_rightarrow" ],
    "repeat_pad_leftx_pos" : [ "focus_right", "bar_right", "viewport_rightarrow" ],
    "repeat_pad_rightx_pos" : [ "focus_right", "bar_right", "viewport_rightarrow" ],

    "repeat_pad_dpup_press" : [ "focus_up", "bar_up", "viewport_uparrow" ],
    "repeat_pad_lefty_neg" : [ "focus_up", "bar_up", "viewport_uparrow" ],
    "repeat_pad_righty_neg" : [ "focus_up", "bar_up", "viewport_uparrow" ],

    "repeat_pad_dpdown_press" : [ "focus_down", "bar_down", "viewport_downarrow" ],
    "repeat_pad_lefty_pos" : [ "focus_down", "bar_down", "viewport_downarrow" ],
    "repeat_pad_righty_pos" : [ "focus_down", "bar_down", "viewport_downarrow" ]
```

--------------------------------

### Show and Scene Statements with ATL Block Example

Source: https://www.renpy.org/doc/html/transforms.html

Example of using ATL blocks with show and scene statements to set properties on the displayed image.

```renpy
show eileen happy:
    xalign 1.

scene bg washington:
    zoom 2.

```

--------------------------------

### Example dialogue screen (say)

Source: https://www.renpy.org/doc/html/screens.html

Declares the default dialogue screen 'say' with parameters 'who' and 'what'. It contains a window with id 'window', a vertical box with 10 pixel spacing, and two text fields with ids 'who' and 'what'.

```renpy
screen say(who, what):
    window id "window":
        vbox:
            spacing 10

            text who id "who"
            text what id "what"

```

--------------------------------

### Sync start position with <sync> filename

Source: https://www.renpy.org/doc/html/audio.html

Syncs the start position of layer_2.opus to the current track in channel music_1 for the first iteration, then plays the whole track in subsequent iterations. By default, the start time remains modified in later loop iterations.

```renpy
play music_2 [ "<sync music_1>layer_2.opus", "layer_2.opus" ]

```

--------------------------------

### Basic Text Shader Examples

Source: https://www.renpy.org/doc/html/textshaders.html

Demonstrates the basic syntax for specifying text shaders by name and with uniforms.

```renpy
"dissolve"
"jitter:u__jitter=1.0, 3.0"
"texture:gold.png"
```

--------------------------------

### Creating and Using a Named Store

Source: https://www.renpy.org/doc/html/python.html

Demonstrates how to define a named store 'mystore' with a function and variables, and how to access them in the game. Also shows adding elements to a substore.

```python
init python in mystore:

    serial_number = 0

    def serial():

        global serial_number
        serial_number += 1
        return serial_number

default character_stats.chloe_substore.friends = {"Eileen",}

label start:
    $ serial = mystore.serial()

    if "Lucy" in character_stats.chloe_substore.friends:
        chloe "Lucy is my friend !"
    elif character_stats.chloe_substore.friends:
        chloe "I have friends, but Lucy is not one of them."

    python in character_stats.chloe_substore:
        friends.add("Jeremy")

```

--------------------------------

### Get Installed Game Build ID

Source: https://www.renpy.org/doc/html/achievement.html

Retrieves the build ID of the currently installed game.

```python
achievement.steam.get_app_build_id()

```

--------------------------------

### Initialize and Populate MusicRoom

Source: https://www.renpy.org/doc/html/rooms.html

This snippet demonstrates the initial setup of a MusicRoom instance and adding music tracks to it. The `fadeout` parameter controls music transition time. Tracks can be set to be always unlocked or unlocked through gameplay.

```python
init python:

    # Step 1. Create a MusicRoom instance.
    mr = MusicRoom(fadeout=1.0)

    # Step 2. Add music files.
    mr.add("track1.ogg", always_unlocked=True)
    mr.add("track2.ogg")
    mr.add("track3.ogg")

```

--------------------------------

### Transform Statement Example (left_to_right, ariana.left, animated_ariana_disp)

Source: https://www.renpy.org/doc/html/transforms.html

Example of defining and using ATL transforms. Shows a left-to-right movement with repeat, a transform with a dotted name, and a parameterized transform that alternates images. The label start demonstrates showing images with the transforms.

```renpy
transform left_to_right:
    xalign 0.
    linear 2 xalign 1.
    repeat

transform ariana.left:
    xalign .3

transform animated_ariana_disp(duration=1.0):
    "ariana"
    pause duration
    "ariana_reverse"
    pause duration
    repeat

label start:
    show eileen happy at left_to_right
    pause
    show animated_ariana_disp
    pause

```

--------------------------------

### CPS tag speed control example

Source: https://www.renpy.org/doc/html/text.html

Shows the cps tag setting text display speed. An argument starting with * is a multiplier; otherwise it is characters per second.

```renpy
"{cps=20}Fixed Speed{/cps} {cps=*2}Double Speed{/cps}"

```

--------------------------------

### Post JSON to URL and Get JSON Back

Source: https://www.renpy.org/doc/html/fetch.html

This example shows how to send JSON data to a server and receive a JSON response using `renpy.fetch`. The `json` parameter sends the data, and `result='json'` parses the response.

```renpy
$ result = renpy.fetch("https://example.com/api", json={"name": "Ren'Py"}, result="json")
```

--------------------------------

### Ren'Py Python List Examples

Source: https://www.renpy.org/doc/html/language_basics.html

Illustrates the creation of empty and populated lists in Python for Ren'Py.

```python
[]
[1]
[1, 2]
[1, 2, 3]
```

--------------------------------

### Combining at property and at transform in a screen

Source: https://www.renpy.org/doc/html/screens.html

Demonstrates using both the at property and an at transform on the same statement. The property must come first and is applied first. The example shows an image with a sepia transform and text with both sepia, truecenter, and an anonymous transform.

```renpy
screen title():
    add "title background":
        at sepia

    text "The Title of the Game":
        at sepia, truecenter
        at transform:
            alpha 0.0
            linear 0.5 alpha 1.0
```

--------------------------------

### Run Ren'Py SDK

Source: https://www.renpy.org/doc/html/chromeos.html

Navigate to the extracted Ren'Py SDK directory and execute the Ren'Py launcher script. This command assumes the SDK is extracted in the 'ab' directory.

```bash
cd ~/ab/renpy-8.5.4-sdkarm
./renpy.sh

```

--------------------------------

### Build Distributions (Windows)

Source: https://www.renpy.org/doc/html/cli.html

Build desktop distributions for Windows, macOS, and Linux using the Ren'Py CLI on Windows. Specify the project path and an output destination.

```batch
cd C:\path\to\renpy
.\lib\py3-windows-x86_64\python.exe renpy.py launcher distribute C:\path\to\project --destination C:\path\to\output

```

--------------------------------

### Escaping lenticular bracket for non-ruby text

Source: https://www.renpy.org/doc/html/changelog.html

In some contexts, the left full-width lenticular bracket (【) must be doubled to '【【' to prevent it from being interpreted as the start of ruby text. This example shows a dialogue line where the bracket is doubled to avoid ruby interpretation.

```renpy
e "【【This is not | ruby text.】"

```

--------------------------------

### Triple-quoted string in screen

Source: https://www.renpy.org/doc/html/changelog.html

Use triple-quoted strings in screen language to create multi-line text displayables. The backslash at the start of the string escapes the newline, allowing the text to begin on the next line. This example creates three lines in one text displayable.

```renpy
screen example():
    text """\
line 1
line 2
line 3"""

```

--------------------------------

### Get save token keys with renpy.get_save_token_keys()

Source: https://www.renpy.org/doc/html/config.html

Run this in the console to print the save token keys for the current computer. The output can be used to define `config.save_token_keys` to trust save files from that computer without a warning.

```python
print(renpy.get_save_token_keys())

```

--------------------------------

### Basic Tooltip Example

Source: https://www.renpy.org/doc/html/screen_actions.html

Demonstrates how to assign tooltips to textbuttons and display the current tooltip.

```renpy
screen tooltip_example():
    vbox:
        textbutton "North":
            action Return("n")
            tooltip "To meet a polar bear."

        textbutton "South":
            action Return("s")
            tooltip "All the way to the tropics."

        textbutton "East":
            action Return("e")
            tooltip "So we can embrace the dawn."

        textbutton "West":
            action Return("w")
            tooltip "Where to go to see the best sunsets."

        $ tooltip = GetTooltip()

        if tooltip:
            text "[tooltip]"

```

--------------------------------

### Set a configuration variable with define

Source: https://www.renpy.org/doc/html/config.html

Use a define statement to set a configuration variable. This example disables rollback by setting config.rollback_enabled to False.

```renpy
define config.rollback_enabled = False

```

--------------------------------

### on statement with show/hide actions

Source: https://www.renpy.org/doc/html/screens.html

Runs an action when a screen event occurs. Events include "show", "hide", "replace", and "replaced"; the example shows showing and hiding a navigation screen on show/hide.

```renpy
screen preferences():
    frame:
        has hbox

        text "Display"
        textbutton "Fullscreen" action Preferences("display", "fullscreen")
        textbutton "Window" action Preferences("display", "window")

    on "show" action Show("navigation")
    on "hide" action Hide("navigation")

```

--------------------------------

### Configure variable fonts in the GUI system

Source: https://www.renpy.org/doc/html/text.html

Sets the font, named instance, and axis values for variable fonts in the GUI system. The example starts with the light instance and makes the text wide. If no instance is given, Ren'Py defaults to "regular" for non-bold text and "bold" for bold text.

```renpy
define gui.text_font = "nunito.ttf"
define gui.text_instance = "light"
define gui.text_axis = {"width" : 125}

```

--------------------------------

### Command Line Test Execution (Linux/macOS)

Source: https://www.renpy.org/doc/html/testcases.html

Example command to run Ren'Py tests from the command line on Linux or macOS. Replace '/path/to/game' with the actual game directory.

```bash
./renpy.sh /path/to/game test quick_start
```

--------------------------------

### General Syntax for CLI Commands

Source: https://www.renpy.org/doc/html/cli.html

These examples show the general syntax for executing Ren'Py CLI commands on Linux/macOS and Windows.

```bash
./renpy.sh [global options...] [<basedir>] [<command>] [command options...]
```

```batch
.\lib\py3-windows-x86_64\python.exe renpy.py [global options...] [<basedir>] [command] [command options...]
```

--------------------------------

### Ren'Py viewport with drag and scrollbars

Source: https://www.renpy.org/doc/html/screens.html

Example screen uses a side layout with a viewport, horizontal and vertical scrollbars, and a draggable image. The scrollbars are bound to the viewport using its id 'vp' with XScrollValue and YScrollValue.

```renpy
screen viewport_example():
    side "c b r":
         area (100, 100, 600, 400)

         viewport id "vp":
             draggable True

             add "washington.jpg"

         bar value XScrollValue("vp")
         vbar value YScrollValue("vp")
```

--------------------------------

### Configure Autosave Notification Callback

Source: https://www.renpy.org/doc/html/config.html

An example of setting up a callback that runs after every autosave, using the Notify action to display an 'Autosaved.' message to the player. The Notify action is a simple way to provide feedback without creating a custom callback.

```python
define config.autosave_callback = Notify("Autosaved.")
```

--------------------------------

### call screen statement examples

Source: https://www.renpy.org/doc/html/screens.html

Examples of the call screen statement with various clauses: as, onlayer, zorder, nopredict, expression, and with. The nopredict keyword prevents screen prediction; evaluating screen arguments during prediction can cause side effects. The with clause causes a transition when the screen is shown, but does not cause an implicit with None before the screen. To disable the implicit with None after the interaction, pass _with_none=False to the screen.

```renpy
call screen my_imagemap

call screen my_screen(side_effect_function()) nopredict

# Shows the screen with dissolve
call screen my_other_screen with dissolve
# The screens instantly hides with None, then the pixellate transition executes
with pixellate

# Shows the screen with dissolve and hides it with pixellate.
call screen my_other_screen(_with_none=False) with dissolve
with pixellate

$ screen_name = "my_screen"
call screen expression screen_name pass (foo="bar")

```

--------------------------------

### Dropdown menu using nearrect with CaptureFocus and ClearFocus

Source: https://www.renpy.org/doc/html/screens.html

Complete screen example showing a dropdown menu. The button captures focus with CaptureFocus("diff_drop"), and the nearrect displays a frame with choices when the focus is present. Each choice sets the difficulty and clears the focus with ClearFocus. The nearrect must be at the top level and last shown apart from its child.

```renpy
default difficulty = "Easy"

screen select_difficulty():

    # This frame can be a very complex layout, if required.
    frame:
        align (.5, .3)
        padding (20, 20)

        has vbox

        # This is the button that is clicked to enable the dropdown
        textbutton "Difficulty: [difficulty]":

            # This action captures the focus rectangle, and in doing so,
            # displays the dropdown.
            action CaptureFocus("diff_drop")

        textbutton "Done":
            action Return()

    # All sorts of other screen elements could be here, but the nearrect needs
    # to be at the top level, and the last thing shown, apart from its child.

    # Only if the focus has been captured, display the dropdown.
    # You could also use showif instead of basic if
    if GetFocusRect("diff_drop"):

        # If the player clicks outside the frame, dismiss the dropdown.
        # The ClearFocus action dismisses this dropdown.
        dismiss action ClearFocus("diff_drop")

        # This positions the displayable near (usually under) the button above.
        nearrect:
            focus "diff_drop"

            # Finally, this frame contains the choices in the dropdown, with
            # each using ClearFocus to dismiss the dropdown.
            frame:
                modal True

                has vbox

                textbutton "Easy" action [ SetVariable("difficulty", "Easy"), ClearFocus("diff_drop") ]
                textbutton "Medium" action [ SetVariable("difficulty", "Medium"), ClearFocus("diff_drop") ]
                textbutton "Hard" action [ SetVariable("difficulty", "Hard"), ClearFocus("diff_drop") ]
                textbutton "Nightmare" action [ SetVariable("difficulty", "Nightmare"), ClearFocus("diff_drop") ]

```

--------------------------------

### Run Ren'Py Project (Linux/macOS)

Source: https://www.renpy.org/doc/html/cli.html

Execute a Ren'Py project from the command line on Linux or macOS. Navigate to the Ren'Py SDK directory first.

```bash
cd /path/to/renpy
./renpy.sh /path/to/project run

```

--------------------------------

### Transform Expression Example: move_right

Source: https://www.renpy.org/doc/html/transforms.html

Example of the Transform Expression Statement. Defines a transform move_right and an image atl example that displays logo_base.png and then runs the move_right transform.

```renpy
transform move_right:
    linear 1.0 xalign 1.0

image atl example:
    # Display logo_base.png
    "logo_base.png"

    # Run the move_right transform.
    move_right
```

--------------------------------

### if statement with renpy.is_skipping()

Source: https://www.renpy.org/doc/html/screens.html

Conditional execution in screen language using if/elif/else, matching the Python/Ren'Py if statement. This example shows a simple indicator that changes based on whether the player is skipping.

```renpy
screen skipping_indicator():
    if renpy.is_skipping():
         text "Skipping."
    else:
         text "Not Skipping."

```

--------------------------------

### Key statement: keybindings for menu and screenshot

Source: https://www.renpy.org/doc/html/screens.html

Defines a screen that binds keys to actions using the key statement. The key statement takes a key name (or list of keys) and a mandatory action property; by default the event is captured and not processed by other displayables. This example binds the game_menu key to the save menu, 'p' to the preferences menu, and both 's' and 'w' to a screenshot.

```renpy
screen keymap_screen():
    key "game_menu" action ShowMenu('save')
    key "p" action ShowMenu('preferences')
    key ["s", "w"] action Screenshot()

```

--------------------------------

### Vbox with two text children

Source: https://www.renpy.org/doc/html/screens.html

Shows a vertical box (vbox) that displays its children one above the other. This example places two text displayables in a vbox.

```renpy
screen vbox_test():
    vbox:
         text "Top."
         text "Bottom."

```

--------------------------------

### showif with ATL events for animated countdown

Source: https://www.renpy.org/doc/html/screens.html

Defines a transform that reacts to the appear, show, and hide ATL events, then uses a showif/elif/else construct in a screen to animate text changes. The transform starts invisible and animates zoom and alpha on each event. The screen provides buttons to set the countdown value, and the label calls the screen.

```renpy
transform cd_transform:
    # This is run before appear, show, or hide.
    xalign 0.5 yalign 0.5 alpha 0.0

    on appear:
        alpha 1.0
    on show:
        zoom .75
        linear .25 zoom 1.0 alpha 1.0
    on hide:
        linear .25 zoom 1.25 alpha 0.0

screen countdown():
    default n = 3

    vbox:
        textbutton "3" action SetScreenVariable("n", 3)
        textbutton "2" action SetScreenVariable("n", 2)
        textbutton "1" action SetScreenVariable("n", 1)
        textbutton "0" action SetScreenVariable("n", 0)

    showif n == 3:
        text "Three" size 100 at cd_transform
    elif n == 2:
        text "Two" size 100 at cd_transform
    elif n == 1:
        text "One" size 100 at cd_transform
    else:
        text "Liftoff!" size 100 at cd_transform

label start:
    call screen countdown
```

--------------------------------

### Install DLC

Source: https://www.renpy.org/doc/html/achievement.html

Requests that a specific DLC, identified by its AppID, be installed.

```python
achievement.steam.install_dlc(_appid_)

```

--------------------------------

### Build Distributions (Linux/macOS)

Source: https://www.renpy.org/doc/html/cli.html

Build desktop distributions for Windows, macOS, and Linux using the Ren'Py CLI on Linux or macOS. Specify the project path and an output destination.

```bash
cd /path/to/renpy
./renpy.sh launcher distribute /path/to/project --destination /path/to/output

```

--------------------------------

### Define a say_arguments_callback function

Source: https://www.renpy.org/doc/html/config.html

Example callback that takes the speaking character and optional arguments, returning a tuple of positional arguments and a dictionary of keyword arguments. It replaces the arguments passed to the callback, including the interact argument.

```python
def say_arguments_callback(who, interact=True, color="#fff"):
    return (), { "interact" : interact, "what_color" : color }

config.say_arguments_callback = say_arguments_callback

```

--------------------------------

### Run Ren'Py Project (Windows)

Source: https://www.renpy.org/doc/html/cli.html

Execute a Ren'Py project from the command line on Windows. Navigate to the Ren'Py SDK directory first.

```batch
cd C:\path\to\renpy
.\lib\py3-windows-x86_64\python.exe renpy.py C:\path\to\project run

```

--------------------------------

### Check if Start Interact

Source: https://www.renpy.org/doc/html/other.html

Checks if the game is currently in the start interaction state.

```python
renpy.is_start_interact()
```

--------------------------------

### Check DLC Installation Status

Source: https://www.renpy.org/doc/html/achievement.html

Checks if a specific DLC, identified by its AppID, is installed.

```python
achievement.steam.dlc_installed(_appid_)

```

--------------------------------

### Define a _ren.py file

Source: https://www.renpy.org/doc/html/ren_py.html

Example of a _ren.py file structure, including an ignored section for imports and a Ren'Py section for script initialization.

```python
# This is not included in the game. It's here so that an editor knows
# the type of strength.
strength = 100

"""renpy
init python:
"""

class BoostStrength(Action):
    """
    Boosts the strength of the player by 10.
    """

    def __call__(self):
        global strength
        strength += 10
        renpy.restart_interaction()
```

```python
init python:

    class BoostStrength(Action):
        """
        Boosts the strength of the player by 10.
        """

        def __call__(self):
            global strength
            strength += 10
            renpy.restart_interaction()
```

--------------------------------

### achievement.steam.install_dlc(_appid_)

Source: https://www.renpy.org/doc/html/achievement.html

Requests the installation of a specific DLC for the game. This prompts the user to install the DLC.

```APIDOC
## achievement.steam.install_dlc(_appid_)

### Description
Requests the installation of the DLC with the specified appid.

### Method
`achievement.steam.install_dlc(_appid_)`

### Parameters
#### Path Parameters
- **_appid_** (integer) - Required - The application ID of the DLC to install.
```

--------------------------------

### SplineMatrix interpolation example

Source: https://www.renpy.org/doc/html/matrixcolor.html

This example demonstrates using a quadratic curve with SplineMatrix to interpolate brightness over time.

```renpy
show eileen happy:
    center
    matrixcolor BrightnessMatrix(0.0)
    linear 2.0 matrixcolor SplineMatrix(BrightnessMatrix(1.0), [ 0.0, 1.0, 0.0 ])
    repeat
```

--------------------------------

### Command Line Test Execution (Windows)

Source: https://www.renpy.org/doc/html/testcases.html

Example command to run Ren'Py tests from the command line on Windows. Replace 'C:\path\to\game' with the actual game directory.

```batch
.\lib\py3-windows-x86_64\python.exe renpy.py C:\path\to\game test quick_start
```

--------------------------------

### achievement.steam.dlc_installed(_appid_)

Source: https://www.renpy.org/doc/html/achievement.html

Checks if a specific DLC is installed for the game. Returns true if installed, false otherwise.

```APIDOC
## achievement.steam.dlc_installed(_appid_)

### Description
Returns True if the DLC with the specified appid is installed, or False otherwise.

### Method
`achievement.steam.dlc_installed(_appid_)`

### Parameters
#### Path Parameters
- **_appid_** (integer) - Required - The application ID of the DLC.
```

--------------------------------

### Replace an italic font variant in config.font_replacement_map

Source: https://www.renpy.org/doc/html/config.html

Maps the italic variant of 'Vera.ttf' to 'VeraIt.ttf' in config.font_replacement_map. The mapping only applies to the exact variant specified; requests for a bold italic version of vera will still get a bold italic version of vera, not a bold version of the italic vera.

```renpy
init python:
    config.font_replacement_map["Vera.ttf", False, True] = ("VeraIt.ttf", False, False)

```

--------------------------------

### Display Help Information

Source: https://www.renpy.org/doc/html/cli.html

Use the --help flag to display a help message showing available commands and syntax. This provides the most up-to-date command information.

```bash
./renpy.sh --help
```

```batch
.\lib\py3-windows-x86_64\python.exe renpy.py --help
```

--------------------------------

### Get Save Slot Modification Time

Source: https://www.renpy.org/doc/html/save_load_rollback.html

Get the last modification time of a save slot with `renpy.slot_mtime()`.

```python
renpy.slot_mtime(slot)

```

--------------------------------

### Ren'Py Python Tuple Examples

Source: https://www.renpy.org/doc/html/language_basics.html

Demonstrates the syntax for creating empty, single-item, and multi-item tuples in Python for Ren'Py.

```python
()
(1,)
(1, "#555")
(32, 24, 200, 100)
```

--------------------------------

### Ren'Py Python Variable Examples

Source: https://www.renpy.org/doc/html/language_basics.html

Shows examples of valid variable names that can be used in Ren'Py Python expressions.

```python
playername
love_love_points
trebuchet2_range
```

--------------------------------

### Ren'Py Test Suite and Test Cases

Source: https://www.renpy.org/doc/html/testcases.html

Defines a Ren'Py test suite named 'quick_start' with two test cases: 'choose_map' and 'leave_map'. It includes setup steps and actions to interact with the game's UI.

```renpy
testsuite quick_start:
    before testcase:
        run Jump("quickstart_demo")
        advance until screen "quickstart_popup"

    testcase choose_map:
        pause 0.5
        click id "quickstart_close" until not screen "quickstart_popup"
        pause 0.5
        advance until screen "choice"
        click "Take the map"
        advance until "You picked the map."
        pause 0.5

    testcase leave_map:
        pause 0.5
        click id "quickstart_close" until not screen "quickstart_popup"
        pause 0.5
        advance until screen "choice"
        click "Leave it"
        advance until "You left the map behind."
        pause 0.5
```

--------------------------------

### Get Autoreload Flag in Python

Source: https://www.renpy.org/doc/html/developer_tools.html

Gets the autoreload flag. This determines if the game will be automatically reloaded after file changes.

```python
renpy.get_autoreload()
```

--------------------------------

### Color Class Initialization

Source: https://www.renpy.org/doc/html/color_class.html

Illustrates the initialization of the Color class. At most one color argument (color, hls, hsv, or rgb) should be provided. If all are None, None is returned.

```python
class Color(_color =None_, _hls =None_, _hsv =None_, _rgb =None_, _alpha =1.0_):
    pass
```

--------------------------------

### Help

Source: https://www.renpy.org/doc/html/screen_actions.html

Displays help content, either by calling a label, opening a file in a browser, or showing a default help screen.

```APIDOC
## Help

### Description
Displays help. The `help` parameter is used to find help in the following ways:
  * If a label with this name exists, the label is called in a new context.
  * Otherwise, this is interpreted as giving the name of a file that should be opened in a web browser.

If `help` is None, `config.help` is used as the default value. If it is also None, the `config.help_screen` screen is shown in a new context, if it exists. Otherwise, does nothing.

### Parameters
- **_help_** (string, optional) - A string that is used to find help.
```

--------------------------------

### Temporary Say Attributes Example

Source: https://www.renpy.org/doc/html/changelog.html

Example of temporary say attributes in Ren'Py, demonstrating how a temporary attribute is reverted after the dialogue.

```renpy
show eileen happy

e "I'm happy."

e @ vhappy "I'm really happy!"

e "I'm still happy."
```

--------------------------------

### achievement.steam.get_subscribed_item_path

Source: https://www.renpy.org/doc/html/achievement.html

Retrieves the local installation path of a Steam Workshop item given its ID. Returns None if the item is not installed.

```APIDOC
## achievement.steam.get_subscribed_item_path(_item_id_)

### Description
Returns the path where an item of user-generated content was installed. Returns None if the item was not installed.

### Parameters
#### Path Parameters
- **item_id** (int) - Required - The item id.

### Method
GET

### Endpoint
/achievement/steam/get_subscribed_item_path

### Response
#### Success Response (200)
- **path** (string or null) - The installation path of the item, or None if not installed.
```

--------------------------------

### Configure Ren'Py Launcher Directories and Files

Source: https://www.renpy.org/doc/html/developer_tools.html

Customize the Ren'Py launcher by creating a project.json file with 'renpy_launcher' key to define open directories and edit files.

```json
{
    "renpy_launcher":
    {
        "open_directory":
        {
            "game": "game",
            "base": ".",
            "images": "game/images",
            "audio": "game/audio",
            "gui": "game/gui"
        },
        "edit_file":
        {
            "script.rpy": "game/script.rpy",
            "options.rpy": "game/options.rpy",
            "gui.rpy": "game/gui.rpy",
            "screens.rpy": "game/screens.rpy"
        }
    }
}

```

--------------------------------

### Show Window

Source: https://www.renpy.org/doc/html/other.html

Ensures the game window is shown.

```python
renpy.shown_window()
```

--------------------------------

### Example of Blocking Rollback in Ren'Py

Source: https://www.renpy.org/doc/html/save_load_rollback.html

This example demonstrates how to use `renpy.block_rollback()` to prevent rollback to a previous menu after a certain point in the game.

```renpy
label final_answer:
    "Is that your final answer?"

menu:
    "Yes":
        jump no_return
    "No":
        "We have ways of making you talk."
        "You should contemplate them."
        "I'll ask you one more time..."
        jump final_answer

label no_return:
    $ renpy.block_rollback()

    "So be it. There's no turning back now."
```

--------------------------------

### Start Game Label

Source: https://www.renpy.org/doc/html/thequestion.html

The entry point for the Ren'Py game. It initializes music, sets the background, displays narrative text, and presents the first player choice.

```renpy
label start:

    # Start by playing some music.
    play music "illurock.opus"

    scene bg lecturehall
    with fade

    "It's only when I hear the sounds of shuffling feet and supplies being put away that I realize that the lecture's over."

    "Professor Eileen's lectures are usually interesting, but today I just couldn't concentrate on it."

    "I've had a lot of other thoughts on my mind...thoughts that culminate in a question."

    "It's a question that I've been meaning to ask a certain someone."

    scene bg uni
    with fade

    "When we come out of the university, I spot her right away."

    show sylvie green normal
    with dissolve

    "I've known Sylvie since we were kids. She's got a big heart and she's always been a good friend to me."

    "But recently... I've felt that I want something more."

    "More than just talking, more than just walking home together when our classes end."

    menu:

        "As soon as she catches my eye, I decide..."

        "To ask her right away.":

            jump rightaway

        "To ask her later.":

            jump later
```

--------------------------------

### Example of NoRollback Usage

Source: https://www.renpy.org/doc/html/save_load_rollback.html

This example demonstrates how an object of a class inheriting from NoRollback behaves with respect to rollback, showing that its attributes are not affected by rollback.

```python
init python:

    class MyClass(NoRollback):
        def __init__(self):
            self.value = 0

label start:
    $ o = MyClass()

    "Welcome!"

    $ o.value += 1

    "o.value is [o.value]. It will increase each time you rollback and then click ahead."
```
Tokens:
Raw