# Home

This module allows you to manage players' homes

<figure><img src="/files/pfoi3kD0Sy990zMwtnYJ" alt=""><figcaption><p>Set home</p></figcaption></figure>

<figure><img src="/files/pDO5eAX71JBWEdVcILEt" alt=""><figcaption><p>Home multi line</p></figcaption></figure>

<figure><img src="/files/nIYjSjsQDzfJJiQP2NeU" alt=""><figcaption><p>Home message</p></figcaption></figure>

<figure><img src="/files/d7fGOloNWFyaqz5q7yTk" alt=""><figcaption><p>Home inventory</p></figcaption></figure>

<figure><img src="/files/3usHN8xjDtMhwENPPxgC" alt=""><figcaption></figcaption></figure>

## Configuration

### Config.yml

{% code fullWidth="true" %}

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

enable: true

# Allow players to have multiple homes.
# You must set the permission the player must have and the home number for that permission.
# If the player has multiple permissions then the maximum number of home will be used.
permissions:
  - permission: "essentials.home.default"
    amount: 3
  - permission: "essentials.home.vip"
    amount: 5
  - permission: "essentials.home.staff"
    amount: 10

# Change the display for/home
#
# IN_LINE: Displays a message with a header and footer (optional) and a message with the list of homes on the same line
# INVENTORY: Displays the player’s homes in an inventory
# INVENTORY_DONUT: Displays the player’s homes in an inventory that works exactly the same as donutsmpt
# MULTI_LINE: Displays a message with a header and footer (optional) and a message per home (You can display buttons to teleport or delete the home quickly)
home-display: MULTI_LINE

# Sets a rule for the names of homes
home-regex: "[a-zA-Z0-9]+"

# Maximum char number for the home name
home-name-max: 16

# Minimum char number for the home name
home-name-min: 1
```

{% endcode %}

### Homes.yml

{% code fullWidth="true" %}

```yaml
name: '#3f3f3fʜᴏᴍᴇs'
size: 54
items:
  decorations:
    item:
      material: GRAY_STAINED_GLASS_PANE
      name: '&e'
    slots:
      - 9-17
  homes:
    type: ZESSENTIALS_HOMES
    slots:
      - 18-53
    item:
      material: '%material%'
      name: '&f%name%'
      lore:
        - '#ffd353ℹ Informations#3f3f3f:'
        - '#3f3f3f• &7World#3f3f3f: #4cd5ff%world%'
        - '#3f3f3f• &7Environment#3f3f3f: #4cd5ff%environment%'
        - ''
        - '&f➥ &nLeft Click&r&7 to teleport'
        - '&f➨ &nDrop key&r&7 to edit material'
        - '&f➦ &nRight Click&r&7 to delete'
    else:
      slots:
        - 31
      item:
        material: RED_STAINED_GLASS_PANE
        name: "#ff0000✗ ʏᴏᴜ ᴅᴏɴ'ᴛ ʜᴀᴠᴇ ʜᴏᴍᴇs"
        lore:
          - '&7To create a home use the command:'
          - ''
          - '#3f3f3f• #4cd5ff/sethome &7<home name>'
  informations:
    slot: 4
    item:
      playerHead: "%player%"
      name: '&fʜᴏᴍᴇs'
      lore:
        - '#ffd353ℹ Informations#3f3f3f:'
        - '#3f3f3f• &7Homes#3f3f3f: #4cd5ff%zessentials_home_count%'
        - '#3f3f3f• &7Max homes#3f3f3f: #4cd5ff%zessentials_home_max%'
        - ''
        - '#3f3f3f• &7Command#3f3f3f: #4cd5ff/sethome &7<home name>'
```

{% endcode %}

### Home\_donut.yml

{% code fullWidth="true" %}

```yaml

name: '#3f3f3fʜᴏᴍᴇs'
size: 36
items:

  # Slot 1 bed
  home1-up:
    pattern:
      fileName: 'home_up' # Pattern file name
      pluginName: 'zEssentials'
      slot: 10
      home: 1

  # Slot 1 dye
  home1-down:
    pattern:
      fileName: 'home_down' # Pattern file name
      pluginName: 'zEssentials'
      slot: 19
      home: 1

  # Slot 2 bed
  home2-up:
    pattern:
      fileName: 'home_up' # Pattern file name
      pluginName: 'zEssentials'
      slot: 11
      home: 2

  # Slot 2 dye
  home2-down:
    pattern:
      fileName: 'home_down' # Pattern file name
      pluginName: 'zEssentials'
      slot: 20
      home: 2

  # Slot 3 bed
  home3-up:
    pattern:
      fileName: 'home_up' # Pattern file name
      pluginName: 'zEssentials'
      slot: 12
      home: 3

  # Slot 3 dye
  home3-down:
    pattern:
      fileName: 'home_down' # Pattern file name
      pluginName: 'zEssentials'
      slot: 21
      home: 3

  # Slot 4 bed
  home4-up:
    pattern:
      fileName: 'home_up' # Pattern file name
      pluginName: 'zEssentials'
      slot: 13
      home: 4

  # Slot 4 dye
  home4-down:
    pattern:
      fileName: 'home_down' # Pattern file name
      pluginName: 'zEssentials'
      slot: 22
      home: 4

  # Slot 5 bed
  home5-up:
    pattern:
      fileName: 'home_up' # Pattern file name
      pluginName: 'zEssentials'
      slot: 14
      home: 5

  # Slot 5 dye
  home5-down:
    pattern:
      fileName: 'home_down' # Pattern file name
      pluginName: 'zEssentials'
      slot: 23
      home: 5

  # Slot 6 bed
  home6-up:
    pattern:
      fileName: 'home_up' # Pattern file name
      pluginName: 'zEssentials'
      slot: 15
      home: 6

  # Slot 6 dye
  home6-down:
    pattern:
      fileName: 'home_down' # Pattern file name
      pluginName: 'zEssentials'
      slot: 24
      home: 6

  # Slot 7 bed
  home7-up:
    pattern:
      fileName: 'home_up' # Pattern file name
      pluginName: 'zEssentials'
      slot: 16
      home: 7

  # Slot 7 dye
  home7-down:
    pattern:
      fileName: 'home_down' # Pattern file name
      pluginName: 'zEssentials'
      slot: 25
      home: 7
```

{% endcode %}

### Home\_delete.yml

{% code fullWidth="true" %}

```yaml
name: '#3f3f3fᴄᴏɴғɪʀᴍ ᴅᴇʟᴇᴛᴇ'
size: 27
items:

  information:
    slot: 13
    item:
      material: BLUE_DYE
      name: '#00a4fcʜᴏᴍᴇ %zmenu_player_value_home_to_delete%'

  cancel:
    type: inventory
    inventory: 'home'
    plugin: 'zMenu'
    slot: 11
    item:
      material: RED_STAINED_GLASS_PANE
      name: '#ff0000ᴄᴀɴᴄᴇʟ'
      lore:
        - '#fcfcfcClick to cancel'

  confirm:
    slot: 15
    commands:
      - 'delhome %zmenu_player_value_home_to_delete%'
    closeInventory: true
    item:
      material: GREEN_STAINED_GLASS_PANE
      name: '#00fc00ᴄᴏɴғɪʀᴍ'
      lore:
        - '#fcfcfcClick to delete'
```

{% endcode %}


---

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