Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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 days 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 (4 months ago)
- Default Branch: master
- Last Pushed: 2024-09-17T15:31:56.000Z (10 days ago)
- Last Synced: 2024-09-20T15:25:58.442Z (7 days ago)
- Topics: action, actions, cli, github-action, github-actions, renpy, workflow
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/setup-renpy
- Size: 1.88 MB
- Stars: 0
- 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).
## 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
See [action.yml](action.yml)
**Basic:**
```yaml
- uses: remarkablegames/setup-renpy@v1
```
## 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.2.3`](https://www.renpy.org/release/8.2.3):
```yaml
- uses: remarkablegames/setup-renpy@v1
with:
cli-version: 8.2.3
- 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
> ```
## Resources
- [Article](https://remarkablegames.org/posts/setup-renpy-cli-github-actions/)
## Examples
- [remarkablegames/renpy-template](https://github.com/remarkablegames/renpy-template/blob/master/.github/workflows/build.yml)
- [remarkablegames/renpy-examples](https://github.com/remarkablegames/renpy-examples/blob/master/.github/workflows/lint.yml)
## Contributions
Contributions are welcome! 👋
## License
[MIT](LICENSE)