> For the complete documentation index, see [llms.txt](https://punishmentgui.bghddevelopment.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://punishmentgui.bghddevelopment.com/default-config-files/settings.yml-1.13+.md).

# settings.yml (1.13+)

## Overview

The **settings.yml** file is the main config files for PunishmentGUI! This contains major plugin settings. 

{% hint style="info" %}
This version is pre-made for 1.13+ servers!
{% endhint %}

Last Updated: 5/20/23

## Default Config

```
#Which menu should /punish <player> open?
Command: "{openmenu:main-menu}"
#Should the console run the punishment command?
ConsoleRunsCommands: false
#Toggle update checks
CheckForUpdates: true
#Menus
menus:
  #main-menu is the default menu, to create more just copy and paste the same format.
  main-menu:
    #You're using this name to access to this menu from anywhere in the configuration where you have action option
    #Just use for action {openmenu:menu-name}
    name: "main-menu"
    menu-title: "&c&lPunishmentGUI"
    menu-size: 54
    fill-menu:
      enabled: true
      item:
        name: " "
        material: "BLACK_STAINED_GLASS_PANE"
        amount: 1
        durability: 0
        lore: []
    items:
      ClientModOffensesItem:
        name: "&a&lClient Mod Offenses"
        material: "IRON_SWORD"
        amount: 1
        durability: 0
        slot: 14
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: false
          #Put command without /
          execute:
            - ""
        action: ""
        lore:
          - ""
          - '&7X-Ray, Forcefield, Speed, Fly, Inventory Hacks, etc'
          - ""
      GeneralOffensesItem:
        name: "&a&lGeneral Offenses"
        material: "HOPPER"
        amount: 1
        durability: 0
        slot: 12
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: false
          #Put command without /
          execute:
            - ""
        action: ""
        lore:
          - ""
          - '&7Command/Map/Class/Skill Exploits, etc'
          - ""
      ChatOffensesItem:
        name: "&a&lChat Offenses"
        material: "WRITABLE_BOOK"
        amount: 1
        durability: 0
        slot: 10
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: false
          #Put command without /
          execute:
            - ""
        action: ""
        lore:
          - ""
          - '&7Verbal Abuse, Spam, Harassment, Trolling, etc'
          - ""
      WarningItem:
        name: "&a&lWarnings"
        material: "ANVIL"
        amount: 1
        durability: 0
        slot: 43
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "warn {player} Spam/Hack Accusation/Trolling -s"
        action: ""
        lore:
          - ' '
          - '&7Example Warning Input:'
          - '&fSpam - Repeatedly writing MEOW'
          - '&fHack Accusation - Accused Tomp13 of hacking'
          - '&fTrolling - was trying to make bob angry in chat '
          - ' '
      PermanentMuteItem:
        name: "&a&lPermanent Mute"
        material: "PAPER"
        amount: 1
        durability: 0
        slot: 25
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "mute {player} Severe Advertising/Other Severe Offense -s"
        action: ""
        lore:
          - '&fMute Duration: &ePermanent'
          - ' '
          - '&7Severe Advertising'
          - '&fJOIN MINECADE! THIS SERVER IS TRASH'
          - ' '
          - '&7Other Severe Offense'
          - '&fDDOS Threats/Death Threats ETC'
          - ' '
      Severity1MuteItem:
        name: "&a&lSeverity 1"
        material: "DYE"
        amount: 1
        durability: 0
        slot: 19
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "mute {player} 1h Light Spam/Light Advertising/Light Abuse-Harassment/Hackusations -s"
        action: ""
        lore:
          - '&fMute Duration: &e1 Hour'
          - ' '
          - '&7Light Spam'
          - '&fSending the same message 2-5 times'
          - ' '
          - '&7Light Advertising'
          - '&fanyone want to play on minecade?'
          - ' '
          - '&7Light Abuse/Harassment'
          - '&fyou are so bad at this game'
          - ' '
          - '&7Hackusations'
          - '&fyoure such a hacker!'
          - ' '
      Severity2MuteItem:
        name: "&a&lSeverity 2"
        material: "DYE"
        amount: 1
        durability: 0
        slot: 28
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "mute {player} 1w Medium Spam/Medium Advertising/Medium Abuse-Harassment/Avoiding Chat Filter"
        action: ""
        lore:
          - '&fMute Duration: &e1 Week'
          - ' '
          - '&7Medium Spam'
          - '&fSending the same message 6-20 times'
          - ' '
          - '&7Medium Advertising'
          - '&fjoin trash.server.net'
          - ' '
          - '&7Medium Abuse/Harassment'
          - '&fyoure terrible, learn to play'
          - '&ftrash off you stupid newb'
          - ' '
          - '&7Avoiding Chat Filter'
          - '&f|_|<S YOU'
          - ' '
      Severity3MuteItem:
        name: "&a&lSeverity 3"
        material: "DYE"
        amount: 1
        durability: 0
        slot: 37
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "mute {player} 1m Severe Spam/Severe Abuse-Harassment -s"
        action: ""
        lore:
          - '&fMute Duration: &e1 Month'
          - ' '
          - '&7Severe Spam'
          - '&fSending the same message 20+ times'
          - '&fSpam Bot'
          - ' '
          - '&7Severe Abuse/Harassment'
          - '&fGO DIE'
          - ' '
      PermanentBanItem:
        name: "&a&lPermanent Ban"
        material: "REDSTONE_BLOCK"
        amount: 1
        durability: 0
        slot: 34
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "ban {player} Severe Threats -s"
        action: ""
        lore:
          - '&fBan Duration: &ePermanent'
          - ' '
          - '&7Severe Threats'
          - '&fKILL THEM ALL WERE GOING TO HACK THE SERVER'
          - ' '
      Severity1GeneralBanItem:
        name: "&a&lSeverity 1"
        material: "DYE"
        amount: 1
        durability: 0
        slot: 21
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "ban {player} 1h Team Killing/Trolling(Gameplay)/Map-Bug Exploiting -s"
        action: ""
        lore:
          - '&fBan Duration: &e1 Hour'
          - ' '
          - '&7Team Killing'
          - '&fIntentionally killing your team'
          - ' '
          - '&7Trolling (Gameplay)'
          - '&fUsing abilities to trap players in spawn'
          - ' '
          - '&7Map/Bug Exploiting'
          - '&fAbusing an exploit to gain an advantage'
          - ' '
      Severity1ClientBanItem:
        name: "&a&lSeverity 1"
        material: "DYE"
        amount: 1
        durability: 0
        slot: 23
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "ban {player} 1d Damage Indicators/Player Radar -s"
        action: ""
        lore:
          - '&fBan Duration: &e1 Day'
          - ' '
          - '&7Examples'
          - '&fDamage Indicators'
          - '&fPlayer Radar'
          - ' '
      Severity2ClientBanItem:
        name: "&a&lSeverity 2"
        material: "DYE"
        amount: 1
        durability: 0
        slot: 32
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "ban {player} 1w Forcefield/Speed Hack/Reach Hack/Other Hack (First Offense) -s"
        action: ""
        lore:
          - '&fBan Duration: &e1 Week'
          - ' '
          - '&7Examples'
          - '&fForcefield'
          - '&fSpeed Hack'
          - '&fReach Hack'
          - '&fOther Hack'
          - '&cFirst Offense Only!'
          - ' '
      Severity3ClientBanItem:
        name: "&a&lSeverity 3"
        material: "DYE"
        amount: 1
        durability: 0
        slot: 41
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "ban {player} 1m Forcefield/Speed Hack/Reach Hack/Fly Hack/Other Hack (Second Offence) -s"
        action: ""
        lore:
          - '&fBan Duration: &e1 Month'
          - ' '
          - '&7Examples'
          - '&fForcefield'
          - '&fSpeed Hack'
          - '&fReach Hack'
          - '&fFly Hack'
          - '&fOther Hack'
          - '&cAlso for second offenders!'
          - ' '
      IPMuteItem:
        name: "&a&lIP Mute"
        material: "TNT"
        amount: 1
        durability: 0
        slot: 7
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "ipmute {player} IPMUTE -s"
        action: ""
        lore:
          - ' '
          - '&fMute Duration: &eForever'
          - '&cIP MUTE'
          - ' '
      IPBanItem:
        name: "&a&lIP BAN"
        material: "TNT"
        amount: 1
        durability: 0
        slot: 7
        message:
          enabled: false
          text: "&eHello &b{player}!"
        command:
          enabled: true
          #Put command without /
          execute:
            - "ipban {player} IPBAN -s"
        action: ""
        lore:
          - ' '
          - '&fBan Duration: &eForever'
          - '&cIP BAN'
          - ' '
```


---

# 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://punishmentgui.bghddevelopment.com/default-config-files/settings.yml-1.13+.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.