> For the complete documentation index, see [llms.txt](https://docs.cozycrafters.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cozycrafters.net/plugin-docs/cozyguides/permissions.md).

# Permissions

## Permissions

| Permission                | Default | Intended For    | Description                                                                                                                                                     |
| ------------------------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cozyguides.use`          | `true`  | Players         | Allows players to use `/guides`, list available guides, start guides, and quit active guides.                                                                   |
| `cozyguides.welcome`      | `true`  | Players         | Allows players to use `/welcome`, `/welcomeguide`, and `/starter`.                                                                                              |
| `cozyguides.admin`        | `op`    | Admins          | Allows access to CozyGuides admin commands and includes the listed admin child permissions in `plugin.yml`. Also required by the `/cozyguides list` subcommand. |
| `cozyguides.admin.reload` | `op`    | Admins          | Allows `/cozyguides reload`.                                                                                                                                    |
| `cozyguides.admin.start`  | `op`    | Staff or admins | Allows `/cozyguides start <guideId> <player>`.                                                                                                                  |
| `cozyguides.admin.stop`   | `op`    | Staff or admins | Allows `/cozyguides stop <player>`.                                                                                                                             |
| `cozyguides.admin.reset`  | `op`    | Admins          | Reserved for future guide progress reset tools. No matching command is documented in the current source.                                                        |

### Recommended Setup

Players:

* `cozyguides.use`
* `cozyguides.welcome`

Staff:

* `cozyguides.admin.start`
* `cozyguides.admin.stop`

Admins:

* `cozyguides.admin`
* `cozyguides.admin.reload`
* `cozyguides.admin.start`
* `cozyguides.admin.stop`

### Notes

* `cozyguides.use` and `cozyguides.welcome` default to everyone in `plugin.yml`.
* Admin permissions default to operators in `plugin.yml`.
* `cozyguides.admin` declares child permissions for reload, start, stop, and reset in `plugin.yml`.
* The current source does not define a wildcard permission such as `cozyguides.*`.
* Guide files can define their own per-guide permission value. The bundled `homes-basics` and `welcome` guide files leave this blank.


---

# 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:

```
GET https://docs.cozycrafters.net/plugin-docs/cozyguides/permissions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
