https://github.com/remarkablegames/setup-renpy
📖 Set up GitHub Actions workflow with Ren'Py CLI.
https://github.com/remarkablegames/setup-renpy
action actions cli github-action github-actions renpy workflow
Last synced: 3 months ago
JSON representation
📖 Set up GitHub Actions workflow with Ren'Py CLI.
- Host: GitHub
- URL: https://github.com/remarkablegames/setup-renpy
- Owner: remarkablegames
- License: mit
- Created: 2024-06-09T17:55:19.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-11T01:26:26.000Z (3 months ago)
- Last Synced: 2025-04-11T22:12:18.441Z (3 months ago)
- Topics: action, actions, cli, github-action, github-actions, renpy, workflow
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/setup-renpy
- Size: 788 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# setup-renpy
[](https://github.com/remarkablegames/setup-renpy/releases)
[](https://github.com/remarkablegames/setup-renpy/actions/workflows/build.yml)
[](https://codecov.io/gh/remarkablegames/setup-renpy)📖 Set up GitHub Actions workflow with [Ren'Py CLI](https://www.renpy.org/doc/html/cli.html). Read the [blog post](https://remarkablegames.org/posts/setup-renpy-cli-github-actions/).
## Quick Start
```yaml
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
**Basic:**
```yaml
- uses: remarkablegames/setup-renpy@v1
```See [action.yml](action.yml)
## Inputs
### `cli-name`
**Optional**: CLI name. Defaults to `renpy-cli`:
```yaml
- 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:
>
> ```yaml
> - uses: remarkablegames/setup-renpy@v1
>
> - run: renpy
> ```### `cli-version`
**Optional**: CLI [version](https://www.renpy.org/release_list.html). Defaults to [`8.3.6`](https://www.renpy.org/release/8.3.6):
```yaml
- uses: remarkablegames/setup-renpy@v1
with:
cli-version: 8.3.6- run: renpy-cli --version
```### `launcher-name`
**Optional**: Launcher name. Defaults to `renpy-launcher`:
```yaml
- 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:
```yaml
- 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`:
```yaml
- uses: remarkablegames/setup-renpy@v1
with:
rapt: false
```### `renios`
**Optional**: iOS Support (Renios). Defaults to `false`:
```yaml
- uses: remarkablegames/setup-renpy@v1
with:
renios: false
```### `web`
**Optional**: Web Platform Support (Renpyweb). Defaults to `false`:
```yaml
- uses: remarkablegames/setup-renpy@v1
with:
web: false
```## Outputs
### `launcher`
[Ren'Py launcher](https://www.renpy.org/doc/html/cli.html#launcher-commands) path:
```yaml
- uses: remarkablegames/setup-renpy@v1
id: renpy- run: renpy-cli ${{ steps.renpy.outputs.launcher }}
```> [!TIP]
> Prefer `renpy-launcher` on Linux and macOS:
>
> ```yaml
> - uses: remarkablegames/setup-renpy@v1
>
> - run: renpy-launcher
> ```## Examples
- [remarkablegames/renpy-template](https://github.com/remarkablegames/renpy-template)
- [remarkablegames/renpy-examples](https://github.com/remarkablegames/renpy-examples)## License
[MIT](LICENSE)