# Rules

This module allows to display the rules of the server either in the chat or in an inventory

<figure><img src="https://3650476264-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfAyz09ASs8veyxsflZ9y%2Fuploads%2FxNeda5C2VV6bdx6zjQyZ%2Frules_messages.png?alt=media&#x26;token=6c7efa5b-2bb6-4268-9730-621164179d48" alt=""><figcaption><p>Rules message</p></figcaption></figure>

<figure><img src="https://3650476264-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfAyz09ASs8veyxsflZ9y%2Fuploads%2FclLLj3mFJYvj1hGJEjGb%2Frules_inventory.png?alt=media&#x26;token=065e8c1a-7656-4a44-936f-9b152fd17743" alt=""><figcaption><p>Rule Inventory</p></figcaption></figure>

## Configuration

### Config.yml

```yaml
########################################################################################################################
#
# ██████╗░██╗░░░██╗██╗░░░░░███████╗░██████╗
# ██╔══██╗██║░░░██║██║░░░░░██╔════╝██╔════╝
# ██████╔╝██║░░░██║██║░░░░░█████╗░░╚█████╗░
# ██╔══██╗██║░░░██║██║░░░░░██╔══╝░░░╚═══██╗
# ██║░░██║╚██████╔╝███████╗███████╗██████╔╝
# ╚═╝░░╚═╝░╚═════╝░╚══════╝╚══════╝╚═════╝░
#
# Documentation: https://zessentials.groupez.dev/modules/rules
#
########################################################################################################################

enable: true

# Defines how to display server rules
# INVENTORY
# MESSAGE
rule-type: INVENTORY
```

### Rules Inventory

```yaml
name: "#3f3f3fʀᴜʟᴇs"
size: 27
items:
  info:
    slot: 12
    item:
      material: RED_BANNER
      name: "#ff0000ʀᴜʟᴇs ɪɴғᴏʀᴍᴀᴛɪᴏɴs"
      lore:
        - ''
        - '#ffd353ℹ Informations#3f3f3f:'
        - '#3f3f3f• &7Following the rules ensures'
        - '#3f3f3f• &7a fair and &aenjoyable &7experience'
        - '#3f3f3f• &7for everyone, fostering a &apositive'
        - '#3f3f3f• &7community atmophere !'
        - ''
  r1:
    slot: 14
    item:
      material: RED_DYE
      name: "#ff0000sᴇʀᴠᴇʀ ʀᴜʟᴇs #1"
      lore:
        - ''
        - '#ffd353ℹ Informations#3f3f3f:'
        - '#3f3f3f• &7Respect all players and staff.'
        - '#3f3f3f• &7No grieging or stealing.'
        - '#3f3f3f• &7No cheating or hacking.'
        - '#3f3f3f• &7Keep chat clean and respectful.'
        - '#3f3f3f• &7No spamming or advertising.'
        - ''
```


---

# Agent Instructions: 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://zessentials.groupez.dev/modules/rules.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.