> For the complete documentation index, see [llms.txt](https://unknown-56-works.gitbook.io/luigiscreen/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://unknown-56-works.gitbook.io/luigiscreen/administration/permissions.md).

# Permissions

LuigiScreen uses granular permissions.

## Administrator permission

```
luigiscreen.admin
```

It is granted to operators by default and includes every command permission, `luigiscreen.see.*`, and access to every protected screen.

## Command permissions

| Permission                   | Command                                  |
| ---------------------------- | ---------------------------------------- |
| `luigiscreen.create`         | `/screen create`                         |
| `luigiscreen.clone`          | `/screen clone`                          |
| `luigiscreen.list`           | `/screen list`                           |
| `luigiscreen.start`          | `/screen start`                          |
| `luigiscreen.stop`           | `/screen stop`                           |
| `luigiscreen.remove`         | `/screen remove`                         |
| `luigiscreen.status`         | `/screen status`                         |
| `luigiscreen.source`         | `/screen source`                         |
| `luigiscreen.playlist`       | `/screen playlist`                       |
| `luigiscreen.event`          | `/screen event`                          |
| `luigiscreen.set`            | `/screen set`                            |
| `luigiscreen.reload`         | `/screen reload`                         |
| `luigiscreen.debug`          | `/screen debug`                          |
| `luigiscreen.mediamtx`       | `/screen mediamtx`                       |
| `luigiscreen.menu.dashboard` | `/screen menu` or `/screen studio`       |
| `luigiscreen.web`            | `/screen web` and Web Studio login links |
| `luigiscreen.vote`           | Cast a vote with `/screen vote`          |

Update notifications use a separate permission:

| Permission           | Purpose                                                                 |
| -------------------- | ----------------------------------------------------------------------- |
| `luigiscreen.update` | Receive a clickable message when a newer public Modrinth version exists |

All individual command permissions default to false. `luigiscreen.update` defaults to operators. Operators also receive everything through `luigiscreen.admin`.

## Screen visibility

New screens are public by default:

```yaml
permission-required: false
```

Protect a screen:

```
/screen set cinema permission true
```

Players now need:

```
luigiscreen.see.cinema
```

Wildcard access:

```
luigiscreen.see.*
```

Players without access do not receive or see that MapEngine display. Permission changes are detected by the regular viewer refresh, so a restart is not required.

## LuckPerms examples

Allow a moderator to start, stop and inspect screens:

```
/lp user PLAYER permission set luigiscreen.start true
/lp user PLAYER permission set luigiscreen.stop true
/lp user PLAYER permission set luigiscreen.status true
```

Allow a player to see only `cinema`:

```
/lp user PLAYER permission set luigiscreen.see.cinema true
```

Allow a group to see every protected screen:

```
/lp group vip permission set luigiscreen.see.* true
```

Do not grant `luigiscreen.mediamtx` to untrusted users because its wizard generates private credentials.

## Control Studio roles

`luigiscreen.menu.*` grants every studio section.

| Permission                       | Section/action                                       |
| -------------------------------- | ---------------------------------------------------- |
| `luigiscreen.menu.dashboard`     | Dashboard                                            |
| `luigiscreen.menu.screens`       | Screen list, details and location                    |
| `luigiscreen.menu.media`         | Media Library                                        |
| `luigiscreen.menu.playlists`     | Playlist inspection and drafts                       |
| `luigiscreen.menu.events`        | Event timeline inspection and drafts                 |
| `luigiscreen.menu.live`          | Live Control, queue, event start and vote management |
| `luigiscreen.menu.groups`        | Screen Groups                                        |
| `luigiscreen.menu.schedules`     | Schedule Calendar                                    |
| `luigiscreen.menu.templates`     | Template installation                                |
| `luigiscreen.menu.diagnostics`   | Diagnostics                                          |
| `luigiscreen.menu.history`       | Audit and Undo                                       |
| `luigiscreen.menu.emergency`     | Emergency confirmation                               |
| `luigiscreen.menu.control`       | Start/stop/hold/skip/repeat/visibility mutations     |
| `luigiscreen.menu.automations`   | Web Studio automation workspace                      |
| `luigiscreen.menu.monitoring`    | Web Studio monitoring workspace                      |
| `luigiscreen.menu.configuration` | Structured drafts and Publish in Web Studio          |
| `luigiscreen.menu.settings`      | Web Studio settings and session workspace            |

`luigiscreen.web` only permits creating a browser session. Every API action still checks the section and command capabilities copied from the player when the one-time link was created. Create a new session after changing that player's permissions.

See [Drafts, History, Emergency and Roles](/luigiscreen/control-studio/safety-roles.md) for recommended staff roles.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://unknown-56-works.gitbook.io/luigiscreen/administration/permissions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
