MMOItems

https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/
Admin
MMOItems is a powerful item plugin for Minecraft servers, allowing you to create custom items with...
Tokens:92,826
Snippets:219
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### MMOItems Custom Recipe Example Configuration

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Custom-Recipes/diff

A complete example demonstrating the structure and parameters for defining a custom recipe in MMOItems, including hidden status, ingredients, experience, and time.

```config
recipe_name:
  hidden: false
  item: MY_SWORD_TYPE MY_SWORD_ID 1
  exp: 50
  time: 40
```

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

### MMOItems Custom Recipe Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Custom-Recipes/diff

Provides a structural example of a custom recipe configuration. It illustrates the key fields like SMITHINGTABLERECIPE, which defines the recipe's structure and components for crafting items.

```config
SMITHINGTABLERECIPE:
  # Example structure for a custom recipe
  # This section would typically define ingredients, crafting time, etc.
  # For instance:
  # ingredients:
  #   ITEM_ID_1: 1
  #   ITEM_ID_2: 2
  # output:
  #   ITEM_ID_OUTPUT: 1
  # amount: 1
  # enchantments: "KEEP"
```

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

### MythicEnchants Support Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Enchant-Plugins

An example implementation of the `EnchantPlugin` interface for the MythicEnchants plugin. It demonstrates how to check if an enchantment is a `MythicEnchant`, how to generate a `NamespacedKey` specific to the plugin, and how to add enchantments to an item's lore using `ItemStackBuilder` and `LoreBuilder`.

```java
public class MythicEnchantsSupport implements EnchantPlugin<MythicEnchant> {
    @Override
    public boolean isCustomEnchant(Enchantment enchant) {
        return enchant instanceof MythicEnchant;
    }
    @Override
    public NamespacedKey getNamespacedKey(String key) {
        return new NamespacedKey(MythicEnchants.inst(), key);
    }
    public void handleEnchant(ItemStackBuilder builder, MythicEnchant enchant, int level) {
        Validate.isTrue(level > 0, "Level must be strictly positive");
        // Type cannot be changed. Must make sure that item is an enchanted book
        if (!builder.getMeta().hasItemFlag(ItemFlag.HIDE_ENCHANTS))
            builder.getLore().insert(0, LoreParser.formatEnchantment(enchant, level));
    }
}
```

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

### MMOItems Station Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Station-Layouts/diff

Example YAML snippet for configuring a crafting station in MMOItems. It defines the station's display name and specifies which layout to use. Layouts are defined in separate YML files.

```yaml
# Name which will be displayed
# when opening the station
name: 'Example Crafting Station (#page#/#max#)'

# The maximum amount of items in the crafting queue ie. the
```

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

### Example Recipe with Triggers

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Recipe%20Triggers

Demonstrates how to define triggers within a recipe configuration. Triggers are executed sequentially when the recipe is successfully crafted.

```yaml
recipes:
    steel-sword:
        ....
        triggers:
        - 'vanilla{type=STICK,amount=3}'
```

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

### Item Tier Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Item-Tiers/diff

An example of how an item tier is defined in the tiers.yml configuration file. This section shows the structure for defining a tier's display name and its associated drop table.

```yml
RARE:
  name: '&6&lRARE'
  # ... other tier configurations like drop tables
```

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

### MMOItems Item Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Config-Format-of-Stats/diff

This snippet demonstrates the configuration structure for an MMOItem, including its base stats, crafting recipe, and associated sound effects for actions like attacking, picking up, or consuming.

```config
campfire:
  '1':
    item: COD
    time: 100
    experience: 10.0
smithing:
  '1':
    input1: DIAMOND_SWORD
    input2: DIAMOND
    craft-permission: youneedthis.tocraft
    crafted-amount: 10.0
sounds:
  on-attack:
    sound: entity.generic.drink
    volume: 1.0
    pitch: 1.0
  on-pickup:
    sound: entity.generic.drink
    volume: 1.0
    pitch: 1.0
  on-consume:
    sound: entity.generic.drink
```

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

### Crafting Station Example Configuration

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Crafting-Stations/diff

Defines a crafting station with a specific name format, maximum queue size, and materials for filling slots and indicating no-recipe states.

```yaml
name: 'Steel Crafting Station (#page#/#max#)'
max-queue-size: 10
items:
  fill:
    material: AIR
  no-recipe:
    material: GRAY_STAINED_GLASS_PANE
```

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

### Crafting Station Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Station%20Layouts

Example YAML configuration for a crafting station. This defines the station's display name, the maximum number of items that can be crafted simultaneously, and the sound played upon action completion. The 'layout' node would reference a specific layout file.

```YAML
# Name which will be displayed
# when opening the station
name: 'Example Crafting Station (#page#/#max#)'
# The maximum amount of items in the crafting queue ie. the
# max number of items players are able to craft simultaneously.
# Must be between 1 and 64.
max-queue-size: 10
# The sound that plays whenever an action is
# completed in the crafting station.
# GET SOUND NAMES HERE:
# https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
sound: ENTITY_EXPERIENCE_ORB_PICKUP
```

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

### MythicMobs Ice Bolt Skill Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Abilities/diff

This snippet shows an example configuration for an 'Ice Bolt' skill in MythicMobs. It is part of a guide explaining how to use ability modifiers within MythicMobs skills, demonstrating the setup for a damaging ice projectile.

```YAML
```yaml
IceBolt:
  # ... (skill definition continues)
```
```

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

### Recipe Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Recipe%20Conditions

Demonstrates how to define conditions within a recipe configuration file. Conditions are listed under the 'conditions' key, with each condition specified as a string containing its type and parameters.

```yaml
recipes:
    steel-sword:
        output: 'mmoitems{type=SWORD,id=STEEL_SWORD}'
        ...
        conditions:
        - 'level{level=5,consume=true}'
        - 'permission{list="mmoitems.recipe.steel-sword,mmoitems.recipe.station.steel"}'
        - 'placeholder{placeholder="%ac_Stat_Weight%~>~1"}'
```

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

### MMOItems Stat Configuration Examples

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Config-Format-of-Stats/diff

Examples of common stat configurations for items within the MMOItems plugin. These settings define various attributes and behaviors of items, such as repair mechanics, ability types, resource management, and stat-based requirements or bonuses.

```config
repair-type: EXAMPLE_REPAIR_STAT
ability: 
ability1: 
type: BLOODBATH
mana: 3.0
mode: RIGHT_CLICK
upgrade: 
workbench: true
health-regeneration: 10.0
mana-regeneration: 10.0
max-stamina: 10.0
stamina-regeneration: 10.0
additional-experience: 50.0
faction-damage-enemy: 50.0
required-dexterity: 10.0
required-strength: 10.0
profession-enchanting: 10.0
profession-smithing: 10.0
profession-mining: 10.0
```

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

### Open Plugin GUIs

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Main%20API%20Features

Provides examples of opening various in-game graphical user interfaces provided by the MMOItems plugin, such as recipe lists, workbenches, and item edition GUIs.

```Java
new AdvancedTypeList(player, 1).open(); // opens the recipe list at type selection
```

```Java
new AdvancedRecipeList(player, MMOItems.plugin.getTypes().get("SWORD")).open(); // opens the recipe list (after selecting item type)
```

```Java
new AdvancedRecipeWorkbench(player).open(); // opens the advanced workbench
```

```Java
new ItemEdition(player, MMOItems.plugin.getTypes().get("STAFF"), "EARTH_STAFF").open(); // opens the edition gui for a specific item
```

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

### MythicEnchantsSupport Class

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Enchant-Plugins/diff

Example Java class declaration for integrating MythicEnchants. This class implements the `EnchantPlugin` interface, suggesting it's part of a system for managing custom enchantments.

```Java
public class MythicEnchantsSupport implements EnchantPlugin<MythicEnchant> {
    // ... implementation details ...
}
```

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

### Smoker Recipe Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Custom-Recipes/diff

This snippet demonstrates the configuration structure for a custom Smoker recipe within MMOItems. It defines the base item properties and the specific crafting type.

```yaml
SMOKERRECIPE:
  base:
    name: Smoker
    material: WATER_BUCKET
  crafting:

```

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

### Configure Recipe Crafting Time

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Crafting-Stations/diff

This example shows how to set a crafting time for a recipe. The `crafting-time` parameter specifies the duration in seconds that players will spend crafting the item, triggering a progress bar.

```yaml
recipes:
  steel-sword:
    # ... other recipe configurations ...
    crafting-time: 10
```

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

### Crafting Station Configuration File Structure

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Crafting-Stations/diff

Example structure for a YML configuration file defining a crafting station. Crafting stations are stored in the /MMOItems/crafting-stations folder, with each YML file representing a unique station ID.

```yml
# Example YML for a crafting station
# File name corresponds to the station-id
# Example: blacksmith_station.yml

# Station display name (optional)
# display-name: "Blacksmith's Forge"

# Station GUI title
title: "&lBlacksmith Forge"

# Station size (rows)
size: 5

# Recipes for this station
recipes:
  - "sword_recipe_1"
  - "armor_recipe_2"

# Conditions for using the station (e.g., permissions, levels)
# conditions:
#   permission: "mmoitems.crafting.blacksmith"
#   level: 10

# Item that represents the station in the world (optional)
# item: "BLACKSMITH_HAMMER"

# Other configuration options like pagination, etc.
```

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

### Item Set Permissions Configuration

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Item-Sets/diff

This snippet shows an example of how permissions are granted for item sets. It lists specific permission strings associated with a set, likely for access control or feature activation within the MMOItems system.

```yaml
granted-permissions:
  - 'hatred.fullset'
  - 'whatever.permission'
  - '......'
```

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

### MythicLib Placeholders Reference

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Placeholders/diff

Provides guidance for users who cannot find a specific placeholder. It directs them to check the MythicLib placeholders documentation as an alternative source.

```APIDOC
Refer to MYTHICLIB PLACEHOLDERS for additional placeholders.
https://gitlab.com/phoenix-dvpmt/mythiclib/-/wikis/Placeholders
```

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

### Enable Vanilla Recipe Book

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Config.yml/diff

Activates the vanilla Minecraft recipe book for MMOItem recipes. This setting is incompatible with the 'recipe-amounts' option and should not be enabled simultaneously.

```yaml
# Enables the vanilla recipe book for MMOItem recipes!
# THIS IS NOT COMPATIBLE WITH RECIPE AMOUNTS!
use-recipe-book: true
```

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

### Get MMOItems Ability Instance

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Main-API-Features/diff

Retrieves an instance of an ability from the AbilityManager using its unique ID. This requires access to the MMOItems plugin and its static methods to interact with the ability system.

```Java
Ability ability = MMOItems.plugin.getAbilities().get("FIREBOLT");
```

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

### Generate MMOItem ItemStack

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Main%20API%20Features

Demonstrates how to create an MMOItem instance from a template and build an ItemStack. It also shows alternative methods for obtaining ItemStacks, including those scaled by player level or tier.

```Java
MMOItem mmoitem = MMOItems.plugin.getMMOItem(MMOItems.plugin.getTypes().get("SWORD"), "CUTLASS");
ItemStack item = mmoitem.newBuilder().build();
```

```Java
ItemStack item = MMOItems.plugin.getItem(MMOItems.plugin.getTypes().get("SWORD"), "CUTLASS");
```

```Java
ItemStack item = MMOItems.plugin.getItem(type, id, level, tier);
```

```Java
ItemStack item = MMOItems.plugin.getItem(type, id, playerdata);
```

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

### MMOItems Upgrade Recipe Configuration

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Upgrading-Recipes/diff

Details the configuration syntax for upgrade recipes in MMOItems, contrasting it with standard crafting recipes. It specifies the use of 'item' instead of 'output' and outlines player requirements for using such recipes.

```APIDOC
Recipe Configuration Syntax:

Upgrade recipes differ from crafting recipes by using the 'item' key instead of 'output' in the first line of the recipe configuration.

Example:
item: "STEEL_SWORD"

Player Requirements for Upgrade Recipes:
- Must meet a minimum player level (e.g., level 5).
- Must possess specific items in their inventory (e.g., 4 steel ingots).
- Must have the item they are trying to upgrade in their inventory (this is an implicit ingredient).

Limitations:
- Upgrade recipes do NOT support crafting time; they are always instant.
- Failure to meet requirements results in an error message for the player.
```

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

### MMOItems Sword Stat Configuration

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Config-Format-of-Stats/diff

Example configuration block for defining sword stats in MMOItems. This format specifies base properties, material, durability, custom data, and display names/lore.

```yaml
WIKISWORD:
  base:
    material: NETHERITE_SWORD
    revision-id: 2
    durability: 100.0
    custom-model-data: 5.0
    max-durability: 1000.0
    will-break: true
    name: '&cThis is a test sword.'
    lore:
```

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

### Keep Lore Prefix

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Revision-ID-System/diff

Preserves lore lines that begin with a specific prefix, commonly a color code. Be aware that this can lead to duplicate lore if the template also has lore starting with this prefix.

```text
kept-lore-prefix
```

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

### MMOItems Core Configuration

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Config.yml/diff

Configuration options for enabling core features and managing vanilla recipe integration. This includes toggling abilities and items, and specifying which vanilla recipes to disable.

```yaml
abilities: false
items: true

# Disables non MMOItems from being crafted in the vanilla workbench.
# Add [] if the list is empty.
disable-vanilla-recipes: []
# - DIAMOND_PICKAXE
# - IRON_BLOCK

# Options for the Item Revision System
item-revision:
```

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

### Open Advanced Type List GUI

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Main-API-Features/diff

Demonstrates how to open the Advanced Type List GUI for players, typically used for recipe selection or item type browsing. This method requires a player object and an integer parameter specifying the initial type selection.

```Java
new AdvancedTypeList(player, 1).open(); // opens the recipe list at type selection
```

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

### Bukkit/Spigot Sound API Reference

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Station-Layouts/diff

Provides a list of available sound identifiers that can be used in Minecraft server configurations, such as for crafting station completion sounds. This is a reference to the official Bukkit API documentation.

```APIDOC
Bukkit Sound API Reference:
  URL: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Sound.html
  Description: Lists all available sound identifiers for use in Minecraft plugins.
  Example Usage:
    sound: ENTITY_EXPERIENCE_ORB_PICKUP
    sound: BLOCK_ANVIL_USE
    sound: MUSIC_DISC_13
```

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

### Item Modifier Configuration Example

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Item-Modifiers/diff

Illustrates how item modifiers are specified within a generation template. This typically involves defining a list of modifiers that can be applied to generated items, potentially with associated probabilities or conditions.

```yaml
# Example item
# This section would define the item's base properties and modifiers.
# Modifiers are packets of item stats with a chance to be added.
# Example: Sharp modifier adds +3 Atk Damage.
# Example: Toxic modifier adds on-hit poison ability.
# Modifiers can have different selection chances and be tied to item tiers.
# The following is a conceptual representation of how modifiers might be listed:

# modifiers:
#   - name: Sharp
#     chance: 0.75
#     tier: common
#   - name: Toxic
#     chance: 0.50
#     tier: rare
#   - name: Swiftness
#     chance: 0.90
#     tier: common

```

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

### MMOItems Configuration Settings

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Config.yml/diff

This section details key configuration options for MMOItems, including item levels and event disabling rules. It explains how to control item behavior like pickup, crafting, clicking, and joining events, and provides context for automatic soulbinding.

```yaml
level: 1

# Here you can disable individual events for when
# Items should automatically soulbind to the player
# (Requires the 'Auto-Bind' stat to be true)
disable-on:
  pickup: false
  craft: false
  click: false
  join: true # 'true' recommended

# Enable, disable, and customize the weapon effects here.
```

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

### NBT Tagging for Enchants

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Enchant-Plugins/diff

Illustrates how some enchant plugins, like AdvancedEnchants, store enchant data using NBT tags. The example shows a tag format `ae_enchant:thorns` where the enchant name is the key and its level is the tag value.

```APIDOC
NBT Tag Example:
  Key: `ae_enchant:thorns`
  Value: Enchant level (e.g., integer)
```

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

### Game Indicators Configuration

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Config.yml/diff

Configures how game indicators, such as damage numbers, are displayed. Includes settings for decimal formatting and the display format string.

```yaml
game-indicators:
  enabled: true
  decimal-format: '0.#
  format: '&c-#'
  #format: '&c&l✦ #'
```

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

### Open Crafting Station GUI Command

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Crafting-Stations/diff

Command to open a specific crafting station GUI for a player. Requires the station ID and the target player's name.

```command-line
/mi stations open {station-id} {player}
```

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

### Retrieve Item Tier Instances

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Main%20API%20Features

Shows how to access the TierManager to check for the existence of a tier, retrieve a specific item tier by its ID, or get a collection of all loaded item tiers.

```Java
TierManager tiers = MMOItems.plugin.getTiers();
boolean exists = tiers.has("RARE");
ItemTier rare = tiers.get("RARE");
Collection<ItemTier> all = tiers.getAll();
```

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

### List Available Crafting Stations Command

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Crafting-Stations/diff

Command to display a list of all available crafting stations within the game.

```command-line
/mi stations list
```

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

### MMOItems Generate Item Command

Source: https://gitlab.com/phoenix-dvpmt/mmoitems/-/wikis/Commands/diff

The /mi generate command is used to create items within the MMOItems system. It requires a player argument and can accept additional arguments for customization. Refer to the 'Obtaining an item' guide for more detailed usage and options.

```APIDOC
/mi generate <player> (extra-args)
  - Generates an item for the specified player.
  - Parameters:
    - <player>: The target player's username or identifier.
    - (extra-args): Optional arguments to customize the generated item. See 'Obtaining an item' for details.
  - Usage Example:
    /mi generate Notch
    /mi generate Steve mythical_sword tier:3
```
Tokens:
Raw