# PokeMail

## Highlights

* Require a specific amount of inventory space before players can claim their mail.
* Make items drop on the ground so no need to worry about full inventory. 
* A notification is sent to the player on login whenever they have a mail.

## Commands

<table><thead><tr><th width="257.33333333333326">Command</th><th width="277">Permission</th><th>Description</th></tr></thead><tbody><tr><td>/pokemail info</td><td>N/A</td><td>Shows the plugin information and commands.</td></tr><tr><td>/pokemail reload</td><td>pokemail.command.reload</td><td>Reloads the configuration files.</td></tr><tr><td>/pokemail [&#x3C;player>]</td><td>pokemail.open.other.mails</td><td>Opens the mail user interface.</td></tr><tr><td>/pokemail send &#x3C;player> &#x3C;mail> [&#x3C;amount>]</td><td>pokemail.command.send</td><td>Sends a mail.</td></tr></tbody></table>

## Main Configuration

<details>

<summary>Expand</summary>

```json
{
  "CommandAlias": [
    "pokemail",
    "pmail"
  ],
  "Mails": {
    "Mail1": {
      "DisplayEnchanted": false,
      "DisplayCount": 1,
      "DisplayItem": "minecraft:dirt",
      "DisplayName": "&61x Dirt",
      "DisplayLore": [
        "&cRequires 1 empty slot in your inventory!"
      ],
      "DisplayNbt": [],
      "RequiredInventorySpace": 1,
      "DroppedItems": [
        ""
      ],
      "Commands": [
        "give %player% minecraft:dirt 1",
        "tell %player% You received 1x Dirt!"
      ]
    },
    "Mail2": {
      "DisplayEnchanted": true,
      "DisplayCount": 1,
      "DisplayItem": "minecraft:chest",
      "DisplayName": "&6Goodies",
      "DisplayLore": [
        "&e- 1x Dirt",
        "&e- 1x Diamond",
        "&cThe items will be dropped on the ground!"
      ],
      "DisplayNbt": [],
      "RequiredInventorySpace": 0,
      "DroppedItems": [
        "minecraft:dirt",
        "minecraft:diamond"
      ],
      "Commands": [
        "tell %player% The 1x Dirt and 1x Diamond has been dropped on the ground!"
      ]
    }
  }
}
```

</details>

## User Interface Configuration

<details>

<summary>Expand</summary>

```json
{
  "UserInterfaceRows": 5,
  "MailUserInterfaceTitle": "&#404040PokeMail",
  "OtherMailInterfaceTitle": "&#404040%player%'s Mails",
  "UserInterface": {
    "0": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "1": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "2": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "3": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "4": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "5": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "6": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "7": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "8": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "9": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "17": {
      "DisplayItem": "minecraft:red_stained_glass_pane"
    },
    "18": {
      "DisplayItem": "minecraft:black_stained_glass_pane"
    },
    "26": {
      "DisplayItem": "minecraft:black_stained_glass_pane"
    },
    "27": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    },
    "35": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    },
    "36": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    },
    "37": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    },
    "38": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    },
    "39": {
      "Type": "previous",
      "DisplayItem": "minecraft:spectral_arrow",
      "DisplayName": "&6Previous"
    },
    "40": {
      "Type": "claim_all",
      "DisplayItem": "cobblemon:eject_pack",
      "DisplayName": "&6Claim All"
    },
    "41": {
      "Type": "next",
      "DisplayItem": "minecraft:spectral_arrow",
      "DisplayName": "&6Next"
    },
    "42": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    },
    "43": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    },
    "44": {
      "DisplayItem": "minecraft:white_stained_glass_pane"
    }
  }
}
```

</details>

## Messages Configuration

<details>

<summary>Expand</summary>

```json
{
  "InventoryFull": "&cYou need to have %slot_amount% empty slot(s) in your inventory to receive this mail!",
  "AvailableMailTitle": "&aYou have a Mail!",
  "AvailableMailSubTitle": "&eCheck using /pokemail",
  "AvailableMailText": "&aYou have a mail, check using /pokemail"
}
```

</details>

## Dependencies

* Java 21
* [GooeyLibs Fabric 1.21.1](https://modrinth.com/mod/gooeylibs)
* [Cobblemon Fabric 1.21.1](https://modrinth.com/mod/cobblemon/)

## Example

{% embed url="<https://youtu.be/QxzqnpPCWLA>" %}