Skip to content

Latest commit

 

History

History

mimic-bukkit

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

mimic-bukkit

Bukkit plugin containing Mimic APIs implementations.

Usage

For Developers

If you are plugins developer, read mimic-bukkit-api. There you'll find a guide on how to use MimicAPI and how to create your own implementation of Mimic APIs.

For Server Owners

If some plugin requires Mimic, just put it into plugins/ folder. Mimic requires Paper 1.20.6+ and Java 21.

You can configure in config.yml what APIs implementations should be used, or use /mimic config command.

Permissions

mimic.admin - Permission to use mimic commands

Commands

Command Description
/mimic Show mimic status
/mimic config Show and change Mimic config
/mimic levels Manage player's levels
/mimic classes Manage player's classes
/mimic resources Manage player's mana and similar
/mimic inventory Player's inventory info
/mimic items Give, find and compare items
/mimic blocks Deal with blocks

Commands without arguments show info and list available subcommands: click a subcommand to use it, hover to see usage.

Supported Implementations

You can find code of all built-in implementations here.

  • Minecraft (Default)
  • AuraSkills (Levels API only) - every skill is a level track, the power level is the primary track
  • mcMMO (Levels API only) - every skill is a level track, the power level is the primary track
  • Jobs Reborn (Levels API only) - every job is a level track, the total level is the primary track
  • ValhallaMMO (Levels API only) - every skill is a level track, the Power skill is the primary track
  • ProSkillAPI
  • MMOCore
  • Heroes
  • Fabled (Levels API only) - every class group is a level track
  • ProRPGItems
  • Permissions-based (Default, ClassSystem API only) - give permission mimic.class.[class_name] to assign class to player
  • ProSkillAPI
  • MMOCore
  • Heroes
  • Fabled (Classes API only) - every class group is a slot
  • ProRPGItems
  • Minecraft (Default) - health minecraft:health, food level minecraft:food and remaining air minecraft:air, no primary resource
  • MMOCore - mmocore:mana (primary), mmocore:stamina and mmocore:stellium
  • Heroes - heroes:mana (primary) and heroes:stamina
  • AuraSkills - auraskills:mana
  • Fabled - fabled:mana

Items of all providers are available via Items, with the provider ID as a namespace of item IDs. The namespace is required. An item belongs to the provider with the highest priority that recognizes it, vanilla items belong to minecraft.

The deprecated ItemsRegistry API also accepts item ID without a namespace or with the mimic namespace and searches it over all providers. Plugins using this API accept MMOItems IDs without item type too, if only one type has the item.

Providers marked with (deprecated API) are provided by the plugin itself via the deprecated ItemsRegistry API.

ID Format: minecraft:[id]
Payload: Item components in the format of /give command, for example [damage=10,unbreakable={}].
ItemMetaPayload in HOCON format is deprecated: it still works, but logs a warning.

ID Format: craftengine:[namespace]/[id]
Payload: Not supported

ID Format: oraxen:[id]
Payload: Not supported

ID Format: customitems:[id]
Payload: Not supported

ID Format: mmoitems:[type]/[id], for example mmoitems:sword/excalibur
Payload: Not supported
An item given to a player is built by MMOItems for this player.

ProRPGItems (deprecated API)

ID Format: prorpgitems:[type]/[id]
Payload: Not supported

RPGInventory (deprecated API)

ID Format: rpginventory:[id]
Payload: Not supported

ID Format: itemsadder:[id] for the default itemsadder namespace, itemsadder:[namespace]/[id] for others
Payload: Not supported

Blocks of all providers are available via Blocks, with the provider ID as a namespace of block IDs. The namespace is required. A block belongs to the provider with the highest priority that recognizes it, vanilla blocks belong to minecraft.

ID Format: minecraft:[id]
State: Block state properties, for example [facing=north]

ID Format: craftengine:[namespace]/[id]
State: Block state properties, for example [facing=north]

ID Format: itemsadder:[id] for the default itemsadder namespace, itemsadder:[namespace]/[id] for others
State: Not supported

ID Format: oraxen:[id], where ID is the ID of the item placing the block
State: Not supported