> 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/warnings/appealing.md).

# Appealing

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

## Setup

### configuration

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

```yaml
warnings-module:
  appeals:
      #enable the ability to appeal a warning
      enabled: true
      # When enabled staff members must enter a reason of approval/rejection
      # of the appeal
      resolve-reason-enabled: false
      # When enabled the player will have to choose an appeal reason from the 
      # list defined in the reasons property
      # When disabled the player will get to fill in a reason himself.
      fixed-reason: true
      reasons:
          - 'MOD abuse'
          - 'I did not do it'
```

### Permissions 

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

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

#### Appeal specific permissions

| Actor  | Permission                           | Description                                                                                                                                                                                                                 |
| ------ | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| player | staff.warnings.appeals.create        | Permission to create an appeal. Players will need this permission to appeal a warning                                                                                                                                       |
| staff  | staff.warnings.appeals.create.other  | Permission to appeal a warning that is not your. You should only give this permission to staff members. This could be useful if for some reason the player can't appeal his warning himself. For example when he is banned. |
| staff  | staff.warnings.appeals.approve       | Permission to approve an appeal                                                                                                                                                                                             |
| staff  | staff.warnings.appeals.reject        | Permission to reject an appeal                                                                                                                                                                                              |
| staff  | staff.warnings.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.                                                                     |

### Add an appeal

![](/files/-MTSNzGm0h-LyyiN8_Kx)

### Select Appeal reason

![](/files/-MTSO4wImFYDcsCsjHdK)

### Appeal opened

![](/files/-MTSOCNoa2OkhTQ-eox1)

### Staff: Manage appeal

![](/files/-MTSOnTqeXiHPbyT6exd)


---

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