Skip to content
book-open

GitHub Action

setup-renpy

v1.4.3 Latest version

setup-renpy

book-open

setup-renpy

Set up GitHub Actions workflow with Ren'Py CLI

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: setup-renpy

              
  uses: remarkablegames/setup-renpy@v1.4.3
Learn more about this action in remarkablegames/setup-renpy

Choose a version

setup-renpy

version build codecov

📖 Set up GitHub Actions workflow with Ren'Py CLI.

Quick Start

name: Ren'Py CLI
on: push
jobs:
  renpy:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Ren'Py
        uses: remarkablegames/setup-renpy@v1

      - name: Get version
        run: renpy-cli --version

      - name: See help
        run: renpy-cli --help

      - name: Set projects directory
        run: renpy-launcher set_projects_directory ..

Usage

See action.yml

Basic:

- uses: remarkablegames/setup-renpy@v1

Inputs

cli-name

Optional: CLI name. Defaults to renpy-cli:

- uses: remarkablegames/setup-renpy@v1
  with:
    cli-name: renpy-cli

- run: renpy-cli

Warning

On Linux and macOS, CLI name cannot be renpy.

Note

On Windows, CLI name is renpy and it cannot be changed:

- uses: remarkablegames/setup-renpy@v1

- run: renpy

cli-version

Optional: CLI version. Defaults to 8.2.3:

- uses: remarkablegames/setup-renpy@v1
  with:
    cli-version: 8.2.3

- run: renpy-cli --version

launcher-name

Optional: Launcher name. Defaults to renpy-launcher:

- uses: remarkablegames/setup-renpy@v1
  with:
    launcher-name: renpy-launcher

- run: renpy-launcher

Important

On Windows, renpy-launcher is unavailable.

renpy-launcher is a shorthand for:

- uses: remarkablegames/setup-renpy@v1
  id: renpy
  with:
    cli-name: renpy-cli

- run: renpy-cli ${{ steps.renpy.outputs.launcher }}

rapt

Optional: Android Support (RAPT). Defaults to false:

- uses: remarkablegames/setup-renpy@v1
  with:
    rapt: false

renios

Optional: iOS Support (Renios). Defaults to false:

- uses: remarkablegames/setup-renpy@v1
  with:
    renios: false

web

Optional: Web Platform Support (Renpyweb). Defaults to false:

- uses: remarkablegames/setup-renpy@v1
  with:
    web: false

Outputs

launcher

Ren'Py launcher path:

- uses: remarkablegames/setup-renpy@v1
  id: renpy

- run: renpy-cli ${{ steps.renpy.outputs.launcher }}

Tip

Prefer renpy-launcher on Linux and macOS:

- uses: remarkablegames/setup-renpy@v1

- run: renpy-launcher

Resources

Examples

Contributions

Contributions are welcome! 👋

License

MIT