Nexo

https://docs.nexomc.com
Admin
Nexo is a Minecraft plugin for creating highly customizable items, blocks, armor, and furniture,...
Tokens:47,811
Snippets:664
Trust Score:5.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Full Dialog Configuration Example

Source: https://docs.nexomc.com/configuration/dialogs.md

A comprehensive example demonstrating all available properties for a dialog, including actions, bodies, and various input types.

```yaml
type: NOTICE
action:
  label: "<red>Notice Label"
  tooltip: "<red>Notice Tooltip"
  width: 150
  action:
    type: RUN_COMMAND
    command: "nexo inventory"
base:
  title: "<red>Title"
  externalTitle: "External Title"
  canCloseWithEscape: true
  afterAction: CLOSE
  bodies:
    message_body:
      type: MESSAGE
      message: "<red>Some Message allowing MiniMessage"
      width: 200
    item_body:
      type: ITEM
      description: "Some Description"
     #description:
     #  contents: "<red>Some description"
     #  width: 200
      showDecorations: true
      showTooltip: true
      width: 16
      height: 16
  inputs:
    text_key:
      type: TEXT
      width: 200
      label: "<red>Text Input Label"
      labelVisible: true
      maxLength: 32
      initial: "Initial Input Text"
      multilineOptions:
        maxLines: 1
        height: 32
    bool_key:  
      type: BOOL
      label: "<red>Boolean Input Label"
      initial: true
      onTrue: "some_action"
      onFalse: "some_action"
    number_key:
      type: NUMBER
      width: 200
      label: "<red>Number Input Label"
      labelFormat: "options.generic_value"
      start: 0
      end: 1
      initial: 0.5
      step: 0.1
    single_key:
      type: SINGLE
      width: 200
      label: "<red>Single Input Label"
      labelVisible: true
      options:
        option_1:
          display: "First Option"
          initial: true
        option_2:
          display: "Second Option"
          initial: false
```

--------------------------------

### Glyph Configuration Example

Source: https://docs.nexomc.com/community-guides/vendors.md

Example configuration for defining glyphs using custom namespaces.

```yaml
santa_claus:
  texture: nexomc:santa_claus
  font: nexomc:christmas_glyphs
  ...
```

--------------------------------

### ResourcePack Structure Examples

Source: https://docs.nexomc.com/configuration/plugin-settings.md

Visual representation of file structures under different obfuscation modes.

```makefile
📁ResourcePack
└── 📁assets
    └── 📁custom_namespace
        └── 📁models
             └── 📑custom_model.json
```

```makefile
📁ResourcePack
└── 📁assets
    └── 📁custom_namespace
        └── 📑02a61ae4-2457-4dfa-91af-9598cd52fd9e.json
```

```text
📁ResourcePack
└── 📁assets
    └── 📁0d003f53-e176-4e74-a895-d392c82f50be
        └── 📁models
             └── 📑02a61ae4-2457-4dfa-91af-9598cd52fd9e.json
```

--------------------------------

### Configure MultiPack Templates

Source: https://docs.nexomc.com/configuration/resourcepack/multipack-feature.md

Example configuration for defining templates with requirements, defaults, and conflict rules.

```yaml
templates:
  custom_music:
    required: false
    default: false
    path: "custom_music"
  2d_tools:
    required: false
    default: true
    conflicts_with: 3d_tools
  3d_tools:
    required: false
    default: false
    conflicts_with: 2d_tools
```

--------------------------------

### Configure Custom GUI Overlays

Source: https://docs.nexomc.com/addons/scaffolding/custom-guis-and-huds.md

Example configuration for defining custom GUI backgrounds and overlays using YAML.

```yaml
autoBackgrounds: true
minHeight: 32

# Nudge an auto-detected background 4px up
my_menu:
  glyph: my_menu
  match_literal: "<glyph:my_menu>"
  screen: container
  offset: "0,-4"

# A glyph that is not in any GUI title, pinned to the furnace screen at a fixed size
forge_overlay:
  glyph: forge_overlay
  match_literal: "<glyph:forge_overlay>"
  screen: furnace
  size: "176px,166px"
```

--------------------------------

### Query documentation via HTTP GET

Source: https://docs.nexomc.com/llms.txt

Perform a GET request to the documentation index with 'ask' and 'goal' parameters to receive a direct answer and relevant excerpts.

```http
GET https://docs.nexomc.com/version-support.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Toggle Templates via Commands

Source: https://docs.nexomc.com/configuration/resourcepack/multipack-feature.md

Example command sequence to list and toggle specific resource pack templates.

```text
/nexo multipack list
/nexo multipack toggle custom_music
/nexo multipack toggle 3d_tools
```

--------------------------------

### Static RUN_COMMAND Action Configuration

Source: https://docs.nexomc.com/configuration/dialogs/dialogaction.md

Example of a static action configuration using the RUN_COMMAND type.

```yaml
action:
  type: RUN_COMMAND
  command: "nexo inventory"
```

--------------------------------

### Furniture Configuration Example

Source: https://docs.nexomc.com/mechanics/furniture-mechanic.md

Basic configuration for a furniture item, including sound effects, hitbox definitions, and drop behavior.

```yaml
myitem:
  itemname: "<gray>Table"
  material: PAPER
  Pack:
    model: default/table
  Mechanics:
    furniture:
      block_sounds:
        place_sound: block.stone.place
        break_sound: block.stone.break
        hit_sound: my.custom.hitsound     # Custom sound as defined in Nexo/sound.yml
        step_sound: my.custom.stepsound   # Requires a sound-file in the Nexo/pack-folder aswell
        fall_sound: my.custom.fallsound
      hitbox:
        barriers:
          - 0,0,0
      drop:
        silktouch: false
        # If no loots section is defined, will drop itself
        #loots:
        #  - { nexo_item: table, probability: 1.0 }
```

--------------------------------

### Duration Format Examples

Source: https://docs.nexomc.com/general-usage/faq.md

Examples of how to define time durations using various units like ticks, seconds, and minutes.

```text
duration: 20t - 20 ticks
duration: 20ms - 20 milliseconds
duration: 20.2s - 20 seconds & 40 ticks
duration: 20.1m - 20 minutes and 6 seconds
```

--------------------------------

### Configure SingleOption-Input

Source: https://docs.nexomc.com/configuration/dialogs/dialogbase.md

Setup for a single-option selection input containing multiple selectable choices.

```yaml
inputs:
  single_key:
    type: SINGLE
    width: 200
    label: "<red>Single Input Label"
    labelVisible: true
    options:
      option_1:
        display: "First Option"
        initial: true
      option_2:
        display: "Second Option"
        initial: false
```

--------------------------------

### Configure NexoItem for 1.21.4+

Source: https://docs.nexomc.com/mechanics/custom-trident.md

Examples for defining a custom trident using either the simple automatic generation method or manual ItemModel configuration.

```yaml
forest_trident:
  itemname: Forest Trident
  material: TRIDENT
  Pack:
    model: nexo:item/nexo_tools/forest_trident
    throwing_model: nexo:item/nexo_tools/forest_trident_throwing
  Mechanics:
    trident:
      display_transform: HEAD
```

```yaml
forest_trident:
  itemname: Forest Trident
  material: TRIDENT
  Components:
    item_model: nexo:forest_trident
  Mechanics:
    trident:
      display_transform: HEAD
```

--------------------------------

### Define Furniture States Configuration

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/furniture-states.md

Example of a furniture item with multiple states that cycle upon interaction.

```yaml
myitem:
  itemname: "<gray>TV"
  material: PAPER
  Pack:
    model: default/tv
  Mechanics:
    furniture:
      hitbox:
        barriers:
          - 0,0,0
      states:
        channel_one:
          type: ITEM_MODEL
          item_model: nexo:furniture/tv_channel_one
        channel_two:
          type: ITEM_MODEL
          item_model: nexo:furniture/tv_channel_two
```

--------------------------------

### Item Debugging Information

Source: https://docs.nexomc.com/general-usage/commands.md

Example output format when running the item info command for debugging purposes.

```yaml
ItemID: my_cool_item                 # this is the ID of the item
CustomModelData: 1000                # the custommodeldata of the item
Material: PAPER                      # the material used for the item
Model Name: minecraft:my_cool_item   # the name of the model, in the final pack you can find this in minecraft/models/my_cool_item.json
```

--------------------------------

### Define a Basic Glyph

Source: https://docs.nexomc.com/configuration/glyphs.md

Example configuration for a standard glyph including optional font, permission, and placeholder settings.

```yaml
heart:
  texture: default/chat/heart
  ascent: 8
  height: 8
  #font: namespace:fontname     Optional, unspecified uses font in settings.yml
  #permission: nexo.glyph.heart Optional, unspecified uses permission in settings.yml
  #placeholders:
  #  - "<3"
```

--------------------------------

### Configure Text-Entities for Furniture

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/text-entities.md

Example configuration for a furniture item using the text_entity property to display multi-line text with formatting.

```yaml
arm_chair:
  itemname: Arm Chair
  material: PAPER
  Pack:
    model: nexo:item/nexo_furniture/arm_chair
    dyeable_model: nexo:item/nexo_furniture/arm_chair_dyeable
    custom_model_data: 1005
  Mechanics:
    furniture:
      # Also allows a list of text_entities;
      # text_entities:
      #   - text: "something"
      #   - text: "something2"
      text_entity: # / text_entities
        offset: 1,1,1
        text:
        - test <red>hi<gradient:red:aqua:light_purple>some text to test gradientssssss<newline>test
        - aaa aaaaaaah<newline>test test again
        tracking_rotation: CENTER
        text_opacity: -1
        line_width: 200
        alignment: LEFT
        shadow: false
        see_through: false
        translation: 0,0,0
```

--------------------------------

### Configure Connectable Furniture via ITEM_MODEL

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/connectable-furniture.md

Example configuration for a connectable furniture item using the ITEM_MODEL mechanic. The commented section demonstrates how to use the ItemModel builder to define connection states.

```yaml
connectable:
  itemname: Connectable
  Components:
    item_model: nexo:connectable/connectable
  ## Below can be used to let Nexo generate the ItemModel file for you
  #ItemModel:
  #  type: select
  #  property: block_state
  #  block_state_property: connectable
  #  cases:
  #    - when: straight
  #      model:
  #        type: model
  #        model: nexo:item/nexo_furniture/connectable/connectable_straight
  #    - when: left
  #      model:
  #        type: model
  #        model: nexo:item/nexo_furniture/connectable/connectable_left
  #    - when: right
  #      model:
  #        type: model
  #        model: nexo:item/nexo_furniture/connectable/connectable_right
  #    - when: inner
  #      model:
  #        type: model
  #        model: nexo:item/nexo_furniture/connectable/connectable_inner
  #    - when: outer
  #      model:
  #        type: model
  #        model: nexo:item/nexo_furniture/connectable/connectable_outer
  Mechanics:
    furniture:
      connectable:
        type: ITEM_MODEL
      hitbox:
        barriers:
        - 0,0,0
```

--------------------------------

### Configure Text-Input field

Source: https://docs.nexomc.com/configuration/dialogs/dialogbase.md

Setup for a text input field with specific width, label visibility, and multiline options.

```yaml
inputs:
  text_key:
    type: TEXT
    width: 200
    label: "<red>Text Input Label"
    labelVisible: true
    maxLength: 32
    initial: "Initial Input Text"
    multilineOptions:
      maxLines: 1
      height: 32
```

--------------------------------

### GET /?ask=<question>&goal=<end_goal>

Source: https://docs.nexomc.com/llms.txt

Performs a query against the documentation index to retrieve an answer and relevant sources.

```APIDOC
## GET /?ask=<question>&goal=<end_goal>

### Description
Perform an HTTP GET request on the documentation index to ask a specific question and optionally provide a broader end goal for context.

### Method
GET

### Endpoint
https://docs.nexomc.com/version-support.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Define Custom Mob Armor Items

Source: https://docs.nexomc.com/configuration/custom-mob-armor-1.21.2%2B

Configuration examples for defining wolf, llama, horse, and nautilus armor items within Nexo.

```yaml
forest_wolf_armor:
  itemname: "Forest Wolf Armor"
  material: WOLF_ARMOR
  Pack:
    texture: nexo:item/nexo_armor/forest_wolf_armor_icon
    CustomArmor:
      wolf_armor: nexo:item/nexo_armor/forest_wolf_armor
forest_llama_armor:
  itemname: "Forest Llama Carpet"
  material: PAPER
  Pack:
    texture: nexo:item/nexo_armor/forest_llama_armor_icon
    CustomArmor:
      llama_armor: nexo:item/nexo_armor/forest_llama_armor
forest_horse_armor:
  itemname: "Forest Horse Armor"
  material: DIAMOND_HORSE_ARMOR
  Pack:
    texture: nexo:item/nexo_armor/forest_horse_armor_icon
    CustomArmor:
      horse_armor: nexo:item/nexo_armor/forest_horse_armor
forest_nautilus_armor:
  itemname: "Forest Nautilus Armor"
  material: DIAMOND_NAUTILUS_ARMOR
  Pack:
    texture: nexo:item/nexo_armor/forest_nautilus_armor_icon
    CustomArmor:
      horse_armor: nexo:item/nexo_armor/forest_nautilus_armor
```

--------------------------------

### Custom Saddle Configuration Example

Source: https://docs.nexomc.com/configuration/custom-mob-armor-1.21.2%2B/custom-saddles-1.21.5%2B.md

Defines a custom saddle item with specific textures for different mobs and restricts usage to pigs and horses.

```yaml
forest_saddle:
  itemname: Forest Saddle
  type: SADDLE
  Pack:
    texture: nexo:items/forest_armor/forest_saddle_icon
    CustomArmor:
      pig_saddle: nexo:items/forest_armor/forest_pig_saddle
      horse_saddle: nexo:items/forest_armor/forest_horse_saddle
  Components:
    equippable:
      slot: BODY
      allowed_enity_types: [ PIG, HORSE ]
```

--------------------------------

### Configure CustomBlock Mechanic

Source: https://docs.nexomc.com/mechanics/custom-block-mechanics/chorusblock-mechanic.md

Setup for the CHORUSBLOCK mechanic, including variation ID, model reference, and drop behavior.

```yaml
my_block:
  Mechanics:
    custom_block:
      type: CHORUSBLOCK
      custom_variation: 2
      model: my_block
      drop:
        silktouch: false
        minimal_type: STONE
        loots:
          - nexo_item: my_block
            probability: 1.0
```

--------------------------------

### Define a custom ItemModel in Nexo

Source: https://docs.nexomc.com/general-usage/faq/itemmodels-vs.-custommodeldata.md

Example configuration for an item using the item_model component instead of CustomModelData.

```yaml
myitem:
  Pack:
    model: mymodel
  Components:
    item_model: nexo:mymodel
```

--------------------------------

### Configure Boolean-Input checkbox

Source: https://docs.nexomc.com/configuration/dialogs/dialogbase.md

Setup for a boolean checkbox input with custom return values for true and false states.

```yaml
inputs:
  bool_key:  
    type: BOOL
    label: "<red>Boolean Input Label"
    initial: true
    onTrue: "true"
    onFalse: "false"
```

--------------------------------

### Build the project locally

Source: https://docs.nexomc.com/addons/nexo-creative-inventory.md

Use the Gradle wrapper to clean and build the project from source.

```bash
./gradlew clean build
```

--------------------------------

### Define DialogBody elements

Source: https://docs.nexomc.com/configuration/dialogs/dialogbase.md

Example configuration for adding MESSAGE and ITEM type bodies to a dialog.

```yaml
base:
  bodies:
    message_body:
      type: MESSAGE
      message: "<red>Some Message allowing MiniMessage"
      width: 200
    item_body:
      type: ITEM
      description: "Some Description"
     #description:
     #  contents: "<red>Some description"
     #  width: 200
      showDecorations: true
      showTooltip: true
      width: 16
      height: 16
```

--------------------------------

### Use Template Placeholders

Source: https://docs.nexomc.com/configuration/items.md

Simplify configurations by using placeholders like <item_id>, <item_id_capitalized>, and <lore> to dynamically inject values.

```yaml
item:
  template: template_item
another_item:
  template: template_item
  lore:
    - "some lore"
template_item:
  itemname: <item_id_capitalized>
  Components:
    item_model: nexo:<item_id>
  lore:
    - "template lore 1"
    - "<lore>"
    - "template lore 2"
```

--------------------------------

### Full MultiPack GUI Configuration

Source: https://docs.nexomc.com/configuration/resourcepack/multipack-feature.md

Complete configuration for a 3-row menu including toggle actions and cycling slots for templates.

```yaml
templates:
  custom_music:
    required: false
    default: false
  2d_tools:
    required: false
    default: true
    conflicts_with: 3d_tools
  3d_tools:
    required: false
    default: false
    conflicts_with: 2d_tools

menu:
  title: "<gold>Resource Pack Options"
  rows: 3

  slots:
    music_toggle:
      offset:
        x: 3
        y: 2
      base_item:
        material: NOTE_BLOCK
        lore:
          - "<dark_gray>Click to toggle"
      action:
        type: TOGGLE
        target: custom_music
        enabled_item:
          itemname: "<green>Music Pack <gray>| <green>Enabled"
        disabled_item:
          itemname: "<red>Music Pack <gray>| <red>Disabled"

    tool_style:
      offset:
        x: 7
        y: 2
      base_item:
        material: STICK
        lore:
          - "<dark_gray>Click to switch style"
      action:
        type: CYCLING
        targets:
          - id: 2d_tools
            itemname: "<aqua>Tools <gray>| <aqua>2D"
          - id: 3d_tools
            itemname: "<gold>Tools <gray>| <gold>3D"
```

--------------------------------

### Place furniture

Source: https://docs.nexomc.com/community-guides/api.md

Use the NexoFurniture class to place furniture at a location, optionally specifying a player.

```java
NexoFurniture.place(itemID, location, @Nullable player)
```

--------------------------------

### Creating a custom music disc NexoItem

Source: https://docs.nexomc.com/configuration/custom-music-discs.md

Define a new item and link it to the previously registered sound using the jukebox_playable component.

```yaml
my_music_disc:
  itemname: My Music Disc
  material: PAPER
  Pack:
    texture: namespace:discs/my_music_disc
  Components:
    jukebox_playable:
      song_key: namespace:my.sound
```

--------------------------------

### Configure NumberRange-Input slider

Source: https://docs.nexomc.com/configuration/dialogs/dialogbase.md

Setup for a numeric slider input with defined range, step increments, and initial value.

```yaml
inputs:
  number_key:
    type: NUMBER
    width: 200
    label: "<red>Number Input Label"
    labelFormat: "options.generic_value"
    start: 0
    end: 1
    initial: 0.5
    step: 0.1
```

--------------------------------

### Configure Repository and Dependencies

Source: https://docs.nexomc.com/community-guides/api.md

Add the Nexo repository and dependency to your project build configuration.

```kotlin
repositories {
    maven("https://repo.nexomc.com/releases")
}

dependencies {
    compileOnly("com.nexomc:nexo:<version>") //Nexo 1.X -> 1.X.0
}
```

--------------------------------

### Item Configuration Directory Structure

Source: https://docs.nexomc.com/community-guides/vendors.md

Recommended organization for item configuration files using subfolders within the items directory.

```text
📁Nexo
└── 📁items
    └── 📁NexoMC
        ├── 📄 christmas_furniture.yml
        └── 📄 easter_armor.yml
```

--------------------------------

### Command Action Configuration

Source: https://docs.nexomc.com/mechanics/custom-mechanic.md

Executes commands from either the console or the player context.

```yaml
myitem:
  Mechanics:
    custom:
      mycustom:
        event: "CLICK:right:all"
        actions:
          - "[console] minecraft:give <player> minecraft:paper 2"
          - "[player] minecraft:give <player> minecraft:paper 2"
```

--------------------------------

### Configure Jukebox Functionality

Source: https://docs.nexomc.com/mechanics/furniture-mechanic.md

Enable jukebox features for furniture with optional volume, pitch, and permission settings.

```yaml
myitem:
  Mechanics:
    furniture:
      jukebox:
        volume: 1.0
        pitch: 1.0
        permission: "nexo.jukebox.play"
```

--------------------------------

### Get 2D Player Head Items

Source: https://docs.nexomc.com/configuration/items/2d-player-heads.md

Commands to spawn 1x1 and 2x2 player head items using the nexo:2d_player_head model identifiers.

```minecraft
/minecraft:give <player> player_head[item_model="nexo:2d_player_head",profile={"name":"boy0000"}]
```

```minecraft
/minecraft:give <player> player_head[item_model="nexo:2d_player_head_large",profile={"name":"boy0000"}]
```

--------------------------------

### Configure POLYMATH ResourcePack Server

Source: https://docs.nexomc.com/configuration/resourcepack.md

Uses the Nexo team's dedicated hosting service for automatic pack delivery.

```yaml
Pack:
  server:
    type: POLYMATH
    polymath:
      server: atlas.nexomc.com
      secret: nexomc
```

--------------------------------

### Define a Custom Armor Item

Source: https://docs.nexomc.com/configuration/custom-armors/components.md

Example configuration for a custom armor item using the COMPONENT type. The material can be any item, and the texture path is specified under the Pack section.

```yaml
forest_helmet:
  material: PAPER    # Can be any material, armor-item or anything else
  Pack:
    # Optional, if not specified, Nexo searches for any texture
    # with the filename armorname_armor_layer_X.png
    #CustomArmor:
    #  layer1: nexo:item/nexo_armors/forest_armor_layer_1
    #  layer2: nexo:item/nexo_armors/forest_armor_layer_2
    texture: nexo:item/nexo_armors/forest_helmet
```

--------------------------------

### Configure Shulker Hitbox in YAML

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/hitbox/shulker-hitbox.md

Define the shulker hitbox parameters within the furniture mechanics configuration. Use the commented-out examples to see how to define multiple hitboxes or specify directions.

```yaml
myitem:
  Mechanics:
    furniture:
      hitbox:
        shulker: 0,0,0 1.0 1.0  #offset scale length direction visible
        #shulkers:
        #  - 0,0,0 1.0 1.0
        #  - 1,0,0 1.2 1.5 EAST
        #  - -1,0,0 0.8 2.0 UP
```

--------------------------------

### Configure Custom Furniture Sounds

Source: https://docs.nexomc.com/mechanics/furniture-mechanic.md

Define custom block sounds for furniture. Use the simple format for default volume/pitch or the expanded format for custom values.

```yaml
myitem:
  Mechanics:
    furniture:
      block_sounds:
        place_sound: block.stone.place
        break_sound: block.stone.break
        hit_sound: my.custom.hitsound     # Custom sound as defined in Nexo/sounds.yml
        step_sound: my.custom.stepsound   # Requires a sound-file in the Nexo/pack-folder aswell
        fall_sound: my.custom.fallsound
```

```yaml
myitem:
  Mechanics:
    furniture:
      block_sounds:
        place:
          sound: block.stone.place
          volume: 1.0
          pitch: 0.2
        break_sound: block.stone.break
        hit_sound: my.custom.hitsound     # Custom sound as defined in Nexo/sounds.yml
        step_sound: my.custom.stepsound   # Requires a sound-file in the Nexo/pack-folder aswell
        fall_sound: my.custom.fallsound
```

--------------------------------

### Configure Custom Storage Containers

Source: https://docs.nexomc.com/mechanics/furniture-mechanic.md

Sets up custom storage containers with specific inventory types, row counts, titles, and interaction sounds.

```yaml
myitem:
  Mechanics:
    furniture:
      storage:
        type: STORAGE
        rows: 5                             # Default: 6
        title: "<red>My Storage"            # Default: "Storage"
        open_sound: entity.shulker.open     # Default: entity.chest.open
        close_sound: entity.shulker.close   # Default: entity.chest.close
```

--------------------------------

### Implement a custom PackServer

Source: https://docs.nexomc.com/community-guides/api.md

Extend NexoPackServer to create a custom pack server implementation. Register the implementation using PackServerRegistry.register.

```kotlin
class MyPackServer : NexoPackServer {
    override fun uploadPack(): CompletableFuture<Void>
    override fun sendPack(player: Player)
    override fun start()
    override fun stop()
    override fun packUrl(): String
    override fun packInfo(): ResourcePackInfo?
}
```

```java
public class PackServer extends NexoPackServer {
    @Override
    public CompletableFuture<Void> uploadPack()
    
    @Override
    public void sendPack(Player player)
    
    @Override
    public void start()
    
    @Override
    public void stop()
    
    @Override
    public String packUrl()
    
    @Override
    @Nullable
    public ResourcePackInfo packInfo()
}
```

--------------------------------

### Sound Action Configuration

Source: https://docs.nexomc.com/mechanics/custom-mechanic.md

Plays a sound with specified source, volume, and pitch settings.

```yaml
myitem:
  Mechanics:
    custom:
      mycustom:
        event: "CLICK:right:all"
        actions:
          - "{source=AMBIENT volume=0.1 pitch=1} [sound] namespace:soundkey"
```

--------------------------------

### NexoItem with pre-made Model file

Source: https://docs.nexomc.com/configuration/items/itemmodel-builder/reference-itemmodel.md

Uses the model property to reference an existing JSON model file in the assets directory.

```yaml
myitem:
  ItemModel:
    type: model
    model: namespace:mymodel #References assest/namespace/models/mymodel.json
```

--------------------------------

### Registering a basic custom sound

Source: https://docs.nexomc.com/configuration/sounds.md

Define a custom sound ID and reference the corresponding OGG file in the assets directory.

```yaml
sounds:
  - id: block.custom.mysound   # id: namespace:id
    sound: nexo:mysound.ogg    # References assets/nexo/sounds/mysound.ogg
    #sounds:                   # Optional, list of sounds where a random will be selected
    #  - mysound.ogg
    #  - mysound2.ogg
```

--------------------------------

### Configure jukebox_playable component

Source: https://docs.nexomc.com/configuration/items/components.md

Marks an item as a music disc for jukeboxes, using a sound key from resource packs or Nexo's sounds.yml.

```yaml
my_item:
  Components:
    jukebox_playable:
      show_in_tooltip: true
      song_key: namespace:key
```

--------------------------------

### Configure NexoItem for 1.21.1+

Source: https://docs.nexomc.com/mechanics/custom-trident.md

Configuration for defining a custom trident and its corresponding thrown projectile item.

```yaml
forest_trident:
  itemname: Forest Trident
  material: TRIDENT
  Pack:
    model: nexo:item/nexo_tools/forest_trident
  Mechanics:
    trident:
      thrown_item: forest_trident_throwing
      display_transform: HEAD

forest_trident_thrown:
  excludeFromCommands: true
  excludeFromInventory: true
  Pack:
    model: nexo:item/nexo_tools/forest_trident_throwing
```

--------------------------------

### Configure Notice Dialog Type

Source: https://docs.nexomc.com/configuration/dialogs/dialogtype.md

Basic configuration for a NOTICE type dialog.

```yaml
type: NOTICE
action:
  ...
```

--------------------------------

### Open Multipack Menu Commands

Source: https://docs.nexomc.com/configuration/resourcepack/multipack-feature.md

Commands to open the multipack GUI for the player or specified targets.

```text
/nexo multipack
/nexo multipack menu
/nexo multipack menu <targets>
```

--------------------------------

### Define MythicMobs Equipment and Drops with NexoItems

Source: https://docs.nexomc.com/compatibility/mythicmobs-custom-mobs.md

Use the nexo: prefix for equipment slots and the nexo keyword for drop tables to integrate custom items.

```yaml
ExampleMob:
  Type: WITHER_SKELETON
  Equipment:
    - IRON_HELMET HEAD
    - nexo:forest_sword HAND
    - nexo:forest_shield OFFHAND
  Drops:
    - nexo forest_chestplate 1to2 1.0
    - #nexo itemid amount probability
```

--------------------------------

### Define Furniture Placements in YAML

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/furniture-placements.md

Configure distinct models and properties for floor, wall, and roof placements within the furniture mechanics section.

```yaml
lantern:
  itemname: "<gray>Lantern"
  material: PAPER
  Pack:
    model: default/lantern
  Mechanics:
    furniture:
      block_sounds:
        place_sound: block.lantern.place
        break_sound: block.lantern.break
      hitbox:
        interaction: 0,0,0 0.5,0.5
      placements:
        floor:
          item_model: nexo:furniture/lantern_floor
        wall:
          item_model: nexo:furniture/lantern_wall
          properties:
            translation: 0,0.3,-0.3
        roof:
          item_model: nexo:furniture/lantern_hanging
          properties:
            translation: 0,-0.4,0
```

--------------------------------

### Configure Animated Painting Metadata

Source: https://docs.nexomc.com/configuration/custom-paintings.md

Create an .mcmeta file to define animation properties for a painting texture.

```json
{
  "animation": {
    "width": 256,
    "height": 256,
    "frametime": 1
    
  }
}
```

--------------------------------

### Configure LOBFILE ResourcePack Server

Source: https://docs.nexomc.com/configuration/resourcepack.md

Uploads the pack to LobFile using a required API key.

```yaml
Pack:
  server:
    type: LOBFILE
    lobfile:
      api_key: YOUR-API-KEY
```

--------------------------------

### Configure Water Placement

Source: https://docs.nexomc.com/mechanics/custom-block-mechanics/stringblock-mechanic.md

Restricts block placement to water surfaces, mimicking lilypad behavior.

```yaml
placeable_on_water:
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      placeable_on_water: true
```

--------------------------------

### Message Action Configuration

Source: https://docs.nexomc.com/mechanics/custom-mechanic.md

Sends a formatted message to the player using MiniMessage syntax.

```yaml
myitem:
  Mechanics:
    custom:
      mycustom:
        event: "CLICK:right:all"
        actions:
          - "[message] <red>some message <gradient:red:blue>with MiniMessage support"
```

--------------------------------

### Recipe Management Commands

Source: https://docs.nexomc.com/general-usage/commands.md

Commands for building, saving, and inspecting custom recipes within the game.

```yaml
/nexo recipe builder <type>    # Start building a new recipe
/nexo recipe save <name>       # Save your recipe
/nexo recipe show all          # See all your recipes
/nexo recipe show <recipe>     # Check a specific recipe
```

--------------------------------

### MultiPack Command Usage

Source: https://docs.nexomc.com/configuration/resourcepack/multipack-feature.md

Commands for interacting with the MultiPack system, including opening the GUI, listing templates, toggling states, and debugging.

```text
/nexo multipack
/nexo multipack menu
/nexo multipack menu <targets>
```

```text
/nexo multipack list
```

```text
/nexo multipack toggle <template>
/nexo multipack toggle <template> <targets>
```

```text
/nexo multipack debug
/nexo multipack debug <targets>
```

--------------------------------

### External Resource Pack Directory Structure

Source: https://docs.nexomc.com/community-guides/vendors.md

Recommended folder hierarchy for organizing external resource packs to prevent namespace conflicts.

```text
📁Nexo
└── 📁pack
    └── 📁external_packs
        ├── 📁RequiredPack.zip         #Nexo Default
        ├── 📁DefaultPack.zip          #Nexo Default
        └── 📁NexoMC
            └── 📁assets
                └── 📁nexomc
                    ├── 📁models
                    |   └── ...
                    └── 📁textures
                        └── ...
```

--------------------------------

### Enable Furniture Rotation

Source: https://docs.nexomc.com/mechanics/furniture-mechanic.md

Add rotation capabilities to furniture items.

```yaml
myitem:
  Mechanics:
    furniture:
      rotatable: true
```

--------------------------------

### Configure MODELENGINE State

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/furniture-states.md

Swaps the furniture's ModelEngine blueprint.

```yaml
      states:
        broken:
          type: MODELENGINE
          blueprint: my_broken_tv
```

--------------------------------

### Configure NexoInventory Layout

Source: https://docs.nexomc.com/configuration/plugin-settings.md

Defines the inventory menu structure, including title, sorting type, and custom button layouts. The path format for menu_layout depends on whether the type is set to FILE or DIRECTORY.

```yaml
nexo_inventory:
  menu_title: <shift:-37><glyph:menu_items_search>
  search_title: <shift:256>NexoInventory Search<shift:256>
  style_default_names: true
  type: FILE
  menu_rows: 6
  menu_layout:
    my_item:
      slot: 1
      icon: itemid
      title: <main_menu_title>ItemID
```

--------------------------------

### Place a custom block

Source: https://docs.nexomc.com/community-guides/api.md

Use the NexoBlocks class to place a custom block at a specific location.

```java
NexoBlocks.place(itemID, location)
```

--------------------------------

### Combine Placements with Limited Placing

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/furniture-placements.md

Restrict furniture placement to specific surfaces while defining unique behaviors for those allowed placements.

```yaml
lantern:
  Mechanics:
    furniture:
      limited_placing:
        floor: false
        wall: true
        roof: true
      placements:
        wall:
          item_model: nexo:furniture/lantern_wall
        roof:
          item_model: nexo:furniture/lantern_hanging
```

--------------------------------

### ActionBar Action Configuration

Source: https://docs.nexomc.com/mechanics/custom-mechanic.md

Displays a formatted message in the player's action bar.

```yaml
myitem:
  Mechanics:
    custom:
      mycustom:
        event: "CLICK:right:all"
        actions:
          - "[actionbar] <red>some message <gradient:red:blue>with MiniMessage support"
```

--------------------------------

### Configure MMOItems as drops

Source: https://docs.nexomc.com/compatibility/mmoitems.md

Specify MMOItems as drops for custom blocks or furniture by providing the mmoitems_id and mmoitems_type.

```yaml
myitemid:
  Mechanics:
    custom_block:
      type: NOTEBLOCK
      drop:
        loots:
          - mmoitems_id: FALCON_BLADE
            mmoitems_type: SWORD
            amount: 1..3 #Optional
    furniture:
      drop:
        loots:
          - mmoitems_id: FALCON_BLADE
            mmoitems_type: SWORD
            amount: 1..3 #Optional
```

--------------------------------

### Define a Brewing Recipe

Source: https://docs.nexomc.com/general-usage/recipes.md

Configures recipes for the Brewing Stand, requiring an input item and a specific ingredient.

```yaml
diamond:
  result:
    minecraft_type: DIAMOND
  input:
    minecraft_type: GLASS_BOTTLE
  ingredient:
    nexo_item: rainbow_ingot
```

--------------------------------

### Define Furnace, Blasting, and Smoking Recipes

Source: https://docs.nexomc.com/general-usage/recipes.md

Configures smelting recipes for furnace-based blocks. Includes parameters for cooking time and experience gain.

```yaml
raw_iron_block_to_iron:
  result:
    minecraft_type: IRON_INGOT
    amount: 9
  input:
    minecraft_type: RAW_IRON_BLOCK
  cookingTime: 100
  experience: 20
```

--------------------------------

### Configure Normal ItemModel for Connection States

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/connectable-furniture.md

Defines a basic ItemModel for a specific connection state and the corresponding furniture configuration.

```json
{
  "model": {
    "type": "minecraft:model",
    "model": "nexo:connectable"
  }
}
```

```yaml
connectable:
  itemname: Connectable
  Components:
    item_model: nexo:connectable/connectable
  Mechanics:
    furniture:
      connectable:
        type: ITEM_MODEL
        default: nexo:connectable/connectable            # We can reuse this item as we want to use the above ItemModel
        straight: nexo:connectable/connectable_straight  #If unspecified, will use default + "_straight"
        left: nexo:connectable/connectable_left          #If unspecified, will use default + "_left"
        right: nexo:connectable/connectable_right        #If unspecified, will use default + "_right"
        inner: nexo:connectable/connectable_inner        #If unspecified, will use default + "_inner"
        outer: nexo:connectable/connectable_outer        #If unspecified, will use default + "_outer"
      hitbox:
        barriers:
        - 0,0,0
```

--------------------------------

### Handle Custom Items

Source: https://docs.nexomc.com/community-guides/api.md

Retrieve and build custom items using the NexoItems API.

```java
ItemBuilder itemBuilder = NexoItems.itemFromId(itemID);
ItemStack itemStack = itemBuilder.build();
String itemId = NexoItems.idFromItem(itemStack);
```

--------------------------------

### Configure Equippable Component

Source: https://docs.nexomc.com/configuration/items/components.md

Sets equipment slot and optional properties like sounds, camera overlays, and entity restrictions.

```yaml
my_item:
  Components:
    equippable:
      slot: HEAD
      #asset_id: minecraft:example
      #camera_overlay: minecraft:example
      #equip_sound: item.armor.equip_chain
      #allowed_entity_types:
      #  - PLAYER
      #  - SKELETON
      #dispensable: true
      #swappable: true
      #damage_on_hurt: true
```

--------------------------------

### Configure ITEM Mechanics for Older Versions

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/connectable-furniture.md

Uses NexoItems to link connection states to specific models for versions prior to 1.21.1.

```yaml
connectable:
  itemname: Connectable
  Pack:
    model: nexo:items/nexo_furniture/connectable/connectable
  Mechanics:
    furniture:
      connectable:
        type: ITEM
        # If default is not specified it will use ItemID by default
        default: connectable            # We can reuse this item as we want to use the above model
        straight: connectable_straight  #If unspecified, will use default + "_straight"
        left: connectable_left          #If unspecified, will use default + "_left"
        right: connectable_right        #If unspecified, will use default + "_right"
        inner: connectable_inner        #If unspecified, will use default + "_inner"
        outer: connectable_outer        #If unspecified, will use default + "_outer"
      hitbox:
        barriers:
        - 0,0,0

#Dummy NexoItems for linking to a Model
connectable_straight:
  excludeFromInventory: true
  excludeFromCommands: true
  Pack:
    model: nexo:item/nexo_furniture/connectable/connectable_straight
connectable_left:
  excludeFromInventory: true
  excludeFromCommands: true
  Pack:
    model: nexo:item/nexo_furniture/connectable/connectable_left
connectable_right:
  excludeFromInventory: true
  excludeFromCommands: true
  Pack:
    model: nexo:item/nexo_furniture/connectable/connectable_right
connectable_inner:
  excludeFromInventory: true
  excludeFromCommands: true
  Pack:
    model: nexo:item/nexo_furniture/connectable/connectable_inner
connectable_outer:
  excludeFromInventory: true
  excludeFromCommands: true
  Pack:
    model: nexo:item/nexo_furniture/connectable/connectable_outer
```

--------------------------------

### Advanced sound configuration

Source: https://docs.nexomc.com/configuration/sounds.md

Configure advanced properties like streaming, volume, pitch, and jukebox compatibility for custom sounds.

```yaml
#https://minecraft.wiki/w/Sounds.json
sounds:
  - id: nexo:music.something
    sound: nexo:music/something.ogg
    sounds:                                  # Alternative if you have more than 1 sound-file
      - nexo:music/something.ogg
      - nexo:music/something2.ogg
    stream: true                             # Optional, defaults to false
    preload: true                            # Optional, defaults to false
    volume: 1f                               # Optional, defaults to 1f
    pitch: 1f                                # Optional, defaults to 1f
    weight: 1                                # Optional, defaults to 1
    attenuation_distance: 13                 # Optional, defaults to 16
    jukebox_playable:                        # Optional, Used for registering a custom music-disc sound
      comparator_output: 15                  # Optional, defaults to 15, must be in 1..15
      range: X                               # Optional, If omitted, the sound will have a variable range.
      duration: 2.5s
      description: Description
```

--------------------------------

### Configure Multi Action Dialog Type

Source: https://docs.nexomc.com/configuration/dialogs/dialogtype.md

Configuration for a MULTI type dialog, defining columns, an exit action, and a list of actions.

```yaml
type: MULTI
columns: 2
exitAction:
  ...
actions: [ ... ]
```

--------------------------------

### Configure Sapling Growth

Source: https://docs.nexomc.com/mechanics/custom-block-mechanics/stringblock-mechanic.md

Sets up natural growth parameters, bonemeal interaction, and schematic structures for saplings.

```yaml
sapling:
  Mechanics:
    custom_block:
      type: STRINGBLOCK
      sapling:
        grows_naturally: true # if you want only the player can grow it
        natural_growth_time: 6000 #in ticks
        grows_from_bonemeal: true
        bonemeal_growth_speedup: 1250
        grow_sound: block.grass.break
        min_light_level: 4
        requires_water_source: false #if you want it to need water
        schematic: schemTest #structure that will put
        # this also allows you to use a list of schematics:
        # schematic:
        # - schem: palmTree1
        #   chance: 0.5
        # - schem: palmTree2
        #   chance: 0.5
        replace_blocks: false
        copy_biomes: false
        copy_entities: false
```

--------------------------------

### Define a simple custom block model

Source: https://docs.nexomc.com/mechanics/custom-block-mechanics/noteblock-mechanic.md

Use a basic parent model like block/cube_all to generate block files from a single texture.

```yaml
my_block:
  itemname: "My block"
  material: DIAMOND
  Pack:
    parent_model: "block/cube_all"
    texture: my_block_texture.png
```

--------------------------------

### ClickAction Configuration

Source: https://docs.nexomc.com/mechanics/clickaction-mechanic.md

Defines a click action with a permission condition and a console command action.

```yaml
myitem:
  Mechanics:      
    furniture/custom_block:
      clickActions:
        - conditions:
            - '#player.hasPermission("test.permission")'
          actions:
            - '[console] say <player> hello <player>!'
```

```yaml
myitem:
  Mechanics:
    furniture/custom_block:
      clickActions:
        - conditions: []
          actions:
            - '[console] say <player> hello <player>!'
```

```yaml
myitem:
  Mechanics:      
    furniture/custom_block:
      clickActions:
        - conditions:
            - '!#player.hasPermission("test.permission")'
          actions:
            - '[console] say <player> hello <player>!'
```

--------------------------------

### Configure PackSquash Integration

Source: https://docs.nexomc.com/configuration/resourcepack.md

Enable and configure the PackSquash integration within the Nexo settings.yml file to optimize resource packs automatically.

```yaml
Pack:
 generation:
    packsquash:
      enabled: true
      executable_path: plugins/Nexo/pack/packsquash/packsquash
      settings_path: plugins/Nexo/pack/packsquash/packsquash.toml
```

--------------------------------

### Multipack Menu Configuration

Source: https://docs.nexomc.com/configuration/resourcepack/multipack-feature.md

Structure for defining the GUI layout and slots within multipack.yml.

```yaml
menu:
  title: "<gold>My Resourcepack Menu"
  rows: 3          # 1–6

  slots:
    my_slot:
      offset: 5,2      # Column (x: 1–9) and row (y: 1–<rows>) of the top-left cell
      size: 1,1        # How many cells wide/tall this slot occupies (defaults to 1×1)
      # Only the top-left cell is interactive, remaining cells show an invisible copy
      all_slots_except_first_empty: false
      base_item:   # Fallback item shown when the action's state has no own item
        material: PAPER
        display_name: "<gray>My Pack"
      action:
        # See action types below
```

--------------------------------

### Configure Furniture Interaction Hitbox

Source: https://docs.nexomc.com/mechanics/furniture-mechanic/hitbox/interaction-hitbox.md

Defines the interaction hitbox dimensions and offset within the furniture mechanics configuration.

```yaml
myitem:
  Mechanics:
    furniture:
      hitbox:
        interaction: 0,0,0 1,1  # offset width,height
        #interactions:
        #  - 0,0,0 1,1
        #  - 1,0,0 1,2.0
        #  - -1,0,0 1,2.2
```

--------------------------------

### Configure ResourcePack Server Hosting

Source: https://docs.nexomc.com/configuration/plugin-settings.md

Defines the hosting method for the resource pack, supporting either local self-hosting or the Polymath remote service.

```yaml
Pack:
  server:
    type: SELFHOST
      selfhost:
        public_address: 0.0.0.0   # Set to your server's IP
        port: 8082                # Set to a port you have opened on your server
      polymath:
        server: atlas.mineinabyss.com
        secret: mineinabyss
```

--------------------------------

### Configure Player Head Profile

Source: https://docs.nexomc.com/configuration/items/components.md

Sets the profile for PLAYER_HEAD items. Requires either name/uuid or properties, not all.

```yaml
myitem:
  material: PLAYER_HEAD
  Components:
    profile:
      name: boy0000
      uuid: 1234
      properties:
        name: name
        value: value
        signature: signature
```

--------------------------------

### Brightness Property

Source: https://docs.nexomc.com/mechanics/furniture-mechanic.md

Overrides vanilla lighting values for the furniture using block and sky light levels.

```yaml
myitem:
  Mechanics:
    furniture:
      properties:
        brightness:
          block_light: 15
          sky_light: 0
```

--------------------------------

### Define Custom Paintings in YAML

Source: https://docs.nexomc.com/configuration/custom-paintings.md

Configure custom and animated paintings in the Nexo/paintings.yml file.

```yaml
paintings:
  nexo:custom_painting:
    author: boy0000
    title: <red>Custom Painting
    asset_id: nexo:custom_painting  # This is the path to the PNG, namespace:path
    width: 1     # The width of your painting, in number of blocks it takes up
    height: 1    # The height of your painting, in number of blocks it takes up
    random_place: true # Will place at random from the vanilla painting items
  nexo:animated_painting:
    author: boy0000
    title: <red>Animated Custom Painting
    asset_id: nexo:animated_painting
    width: 1
    height: 1
```
Tokens:
Raw