CHANGELOG.md

Unreleased

Added command /mimic config

Since now, it is possible to change Mimic config using commands in two ways:

1. Using interactive config /mimic config. Every option in the output is interactive, so you can change it just by mouse click.
2. Change options by commands:
   • /mimic config level-system [value] - set the specified level system as preferred for Mimic
   • /mimic config class-system [value] - set the specified class system as preferred for Mimic
   • /mimic config inventory-provider [value] - set the specified inventory provider as preferred for Mimic
   • /mimic config disabled-items-registries add [item-registry] - disable the specified item registry for Mimic
   • /mimic config disabled-items-registries remove [item-registry] - enable the specified item registry for Mimic

API changes

• Added tag @since 0.8.0 to all new APIs
• Make BukkitPlayerInventory.collectEquippedItems protected. It was public by an accident.

Plugin changes

• Command /mimic info replaced with command /mimic
• Command /mimic class has replaced with command /mimic class check with slightly simpler syntax

Housekeeping

• Update required Java 1.8 → 16
• Update Kotlin 1.6.20 → 1.9.20
• Replace ACF with CommandAPI
• Update Gradle 7.4.2 → 8.5
• Update dependencies
• Migrate to version catalogs

v0.8.0 (2022-04-18)

PlayerInventory API

This version introduces new experimental PlayerInventory API. For now, it can be used only to get player's inventory content and equipped items. It can be useful for integration with plugins providing custom player inventory.

// Get player's inventory
Mimic mimic = Mimic.getInstance();
BukkitPlayerInventory inventory = mimic.getPlayerInventory(player);

// Get items equipped on the player
List<ItemStack> equippedItems = inventory.getEquippedItems();
// Get not equipped items stored in the inventory
List<ItemStack> storedItems = inventory.getStoredItems();
// Get both equpped and not equipped items
List<ItemStack> allItems = inventory.getItems();

This API is experimental, so it can be changed further. I'll do my best to save backward compatibility but in some cases it is not possible. It also means I'm open for ideas how to improve this API to make it more useful. Please, write me in Discord or file an issue if you have any ideas.

API changes

• Make implementations ID validation less strict. Since now, it may contain more special symbols: ._-
• Make ServicesManager extensions inaccessible from Java

Plugin changes

• Added command /mimic inventory info to get info about current player inventory provider

Fixed

• Catch not only Exceptions from ItemsRegistry implementations but also Errors. ItemsRegistry will not crash other plugins.

Housekeeping

• Versioning strategy changed. Now version always includes PATCH version according to SemVer.
• Update Kotlin to 1.6.20
• Update bStats to 3.0.0
• Update ACF to 0.5.1-SNAPSHOT
• Update Gradle to 7.4.2
• Update Dokka to 1.6.20
• Update binary-compatibility-validator to 0.9.0
• Update gradle-download-task to 5.0.5

v0.7.1 (2022-02-19)

Fixed

• Compatibility with Minecraft 1.13 - 1.16.5
• FileNotFoundException on config initialization

v0.7 (2022-02-06)

New implementations registration API

Registration via ServiceManager is deprecated because it was error-prone and not intuitive. Since now, you should use class Mimic to register or get APIs implementations.

Mimic mimic = Mimic.getInstance();

// Register ItemsRegistry implementation
mimic.registerItemsRegistry(new MyItemsRegistry(), plugin);

// Get items registry imlpementation
BukkitItemsRegistry registry = mimic.getItemsRegistry();

New mechanism allows maintaining better backward compatibility for APIs implementations. It also allows users to select preferred APIs implementation via config.

API Changes

• Added default implementations for MimicService methods:
  • isEnabled() returns true by default
  • getId() returns lowercase plugin name by default
• Breaking change! ID should contain only lowercase Latin letters and digits (a-z, 0-9).
• Breaking change! BukkitClassSystem.Provider and BukkitLevelSystem.Provider converted to interface instead of abstract classes. If you want to use ID different from plugin name, you should override getId() method.
• BukkitClassSystem.Provider and BukkitLevelSystem.Provider are functional interfaces since now.

Plugin changes

• Added config file allowing to specify preferred APIs implementations.
• Fixed errors in case when commands used from console.

v0.6.3 (2022-01-07)

Fixed

• Update MMOItems and MMOCore to the latest version

v0.6.2 (2021-12-29)

API Changes

• Added vararg variants of ClassSystem methods

Fixed

• Check plugin exists before registering built-in integrations
• Isolate MimicItemsRegistry from exceptions thrown from other items registries implementations.

Housekeeping

• Update Kotlin to 1.6.10
• Update Gradle to 7.3.3
• Migrate tests to MockK and Kotest assertions

v0.6.1 (2021-08-23)

Fixed

• MimicApiLevel.checkApiLevel now works correctly

v0.6 (2021-08-19)

API

• Add MimicApiLevel class to check current running Mimic API version:

  // Specify here the version required for APIs you use.
  if (!MimicApiLevel.checkApiLevel(MimicApiLevel.VERSION_0_6)) {
      println("At least Mimic 0.6 is required. Please download it from {link here}")
  }

• Add optional payload to ItemsRegistry.getItem. It may be used to customize item.

Bukkit Plugin

• More detailed output of command /mimic items info:

  Items Service: mimic
  Known IDs amount: 1161
    rpginventory: 4
    quantumrpg: 55
    mmoitems: 126
    minecraft: 976
  

• Improve integration with Heroes class system (#14)
• Add statistics about used items registries
• Add payload support to MinecraftItemsRegistry.

Housekeeping

• Add API binary compatibility validation
• Publish docs to GitHub Pages
• Update Kotlin to 1.5.21
• Update bukkit-gradle to 0.10.0
• Update Gradle to 7.2