> For the complete documentation index, see [llms.txt](https://wiki.staffplusplus.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.staffplusplus.org/features/muting/appealing.md).

# Appealing

This page explains how you can setup the mute appealing system. The system allows players to appeal when a mute has been issued towards them.\
Should they find the mute unjustified they can appeal and a staff member can approve or reject the appeal. If the appeal is approved the mute is undone[.](/features/warnings/actions-punishments.md) 

## Setup

### configuration

Underneath the `mute-module` make sure to configure the `appeals` section.

```yaml
mute-module:
   appeals:
      enabled: true
      unmute-on-approve: true
      resolve-reason-enabled: false
      fixed-reason: true
      reasons:
          - 'SPAMMING'
          - 'PROFANITY'
      on-approved-commands: []
      on-rejected-commands: []
```

### Permissions 

Following permission **must** be set or the appeals functionality can not be used:

| Permission                | Description                                                                                                                                                                   |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| staff.mutes.view-my-mutes | Permission to open a GUI showing all your mutes. All players should get this permission. This is needed because it's the only entrypoint to the GUI where players can appeal. |
| staff.mutes.mute-view     | Allows the usage of the `manage-mutes` command. This is the entrypoint to the GUI that shows player mutes.                                                                    |

#### Appeal specific permissions

| Actor  | Permission                        | Description                                                                                                                                             |
| ------ | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| player | staff.mutes.appeals.create        | Permission to create an appeal. Players will need this permission to appeal a mute                                                                      |
| staff  | staff.mutes.appeals.create.other  | Permission to appeal a mute that is not yours. You should only give this permission to staff members.                                                   |
| staff  | staff.mutes.appeals.approve       | Permission to approve an appeal                                                                                                                         |
| staff  | staff.mutes.appeals.reject        | Permission to reject an appeal                                                                                                                          |
| staff  | staff.mutes.appeals.notifications | Permission to get appeal notifications. When you have this permission you will get notified about open appeals and whenever a player creates an appeal. |


---

# 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://wiki.staffplusplus.org/features/muting/appealing.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.