Skip to content

docs: clarify custom launcher execution policy #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wizzomafizzo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify custom launcher execution policy #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/features/custom-launchers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ When Core cannot track the launched process, features that depend on active medi

## Creating a custom launcher

:::warning Only install launchers you trust
Custom launcher files can run programs and scripts on your device with the same permissions as Zaparoo Core. Their launch commands and configured controls do not need approval through `allow_execute`. Treat installing a shared launcher file like installing a script: check what it runs before copying it into your `launchers` folder.
:::

To start, open the `launchers` directory in the Core data folder. Check the page for your [platform](../platforms/index.mdx) if you're not sure where that folder is.

Create a new file ending in `.toml`. This example uses `OpenEmuGB.toml`. The filename is not important, but launcher IDs are, so use a unique ID.
Expand Down Expand Up @@ -150,7 +154,7 @@ lifecycle = "background"

Define control actions that can be triggered on active media via [launcher controls](./launchers.md#launcher-controls). Values are [ZapScript](../zapscript/index.md) strings that run in a restricted control runtime. Media-launching, playlist, and nested `control` commands are blocked, but utility commands like `input.keyboard`, `execute`, `delay`, and `echo` are allowed.

The `execute` command in control scripts still requires a matching [`allow_execute`](../core/config.md#allow_execute) entry.
The `execute` command in configured control scripts does not require an [`allow_execute`](../core/config.md#allow_execute) entry, matching the launcher's own `execute` command. The same command sent directly from a token or the run API still requires the allowlist. Configured controls still respect `block_commands`, and remotely fetched ZapScript cannot bypass the execute restrictions.

```toml
[[launchers.custom]]
Expand Down