# 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[.](https://wiki.staffplusplus.org/features/warnings/actions-punishments) 

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