🔗Compatibility

The compatibility of plugins mainly includes hooks for item plugins and economy plugins. Unlike other plugins of the same type, we can support them regardless of their appearance. There are two methods to support them: direct compatibility and indirect compatibility.

Direct compatibility

Direct compatibility refers to the use of item plugins or the economy of economic plugins directly in ItemFormat or EconomyFormat. This compatibility method is the simplest and officially supported.

Directly supported item plugins list

• ItemsAdder

• Oraxen

• EcoItems

• EcoArmor

• MMOItems

• MythicMobs

• eco

• NeigeItems

• ExecutableItems

• Nexo

Directly supported economy plugins list

• PlayerPoints

• CoinsEngine

• UltraEconomy

• EcoBits

• PEconomy

• RedisEconomy

• RoyaleEconomy

• VotingPlugin

The following provides an example of directly obtaining items from the ItemsAdder plugin through the direct compatibility feature in ItemFormat and using economy from Vault plugin in EconomyFormat:

items:
  A:
    price-mode: CLASSIC_ALL
    product-mode: CLASSIC_ALL
    products:
      1: 
        hook-plugin: ItemsAdder # Item Format
        hook-item: fishing_pack:common_fishing_bait # Item Forma
    buy-prices:
      1:
        economy-plugin: Vault # Economy Format
        amount: 5
        start-apply: 0
        placeholder: '&65 Coins'

Indirect compatibility

Indirect compatibility refers to the flexible use of various features of plugins to enable them to associate with these plugins:

Example: Use for not supported item plugins as products

In this example, we first fill in the ItemFormat through the display item option to describe the item from an incompatible plugin, so that players can see what the item looks like in the menu.

In the products option, we use the Custom Sell Match feature, which allows us to flexibly set the rules for selling matches for this item, such as contains lore, etc. Then, we use give-actions format to execute the item give command, so that player can obtain this item after buy.

    display-item:
      material: APPLE
      # You can hold the item and type command /shop generateitemformat to get the ItemFormat here.
    products:
      1:
        # Sell Match
        match-item:
          contains-lore:
            - 'test1'
        # Buy Give Command
        give-actions:
          1:
            type: console_command
            command: 'items give {player} {amount}'
          2:
            type: message
            message: 'test message'
        amount: 64

If you use the Paper server and the item is fixed (the items generated each time are identical), you can use the Save item function: you only need to use the /shop saveitem command, then use the material option in ItemFormat, and fill in the ID of the save item in this option.

Example: Use for not supported economy plugins as prices.

In this example, we mainly flexibly implemented different types of single thing and give-actions options, whose functions can be found on the Products page. Specifically, assuming the player purchases this product, the match-placeholder in buy options is used to determine if the player has enough economy. If it meets the requirement, the player will receive an apple. As a result, the give-actions will be executed and the player's economy will be taked. Similarly, during selling, as the player obtains the sell price, the give-actions in the sell price will be executed, and therefore the player will receive economy.

    products:
      1:
        # The product
        material: APPLE
        # Buy Give Command
        give-actions:
          1:
            type: console_command
            command: 'eco take {player} {amount}'
        amount: 64
    buy-prices:
      1:
        # Buy Match Placeholder
        match-placeholder: '%economy_now_balance_placeholder%'
        amount: 500
    sell-prices:
      1:
        # Sell Give Command
        give-actions:
          1:
            type: 'console_command'
            command: 'eco give {player} {amount}'
        amount: 500

NeigeItems Item Name Translation Hook

• Download NeigeItems here: https://github.com/ankhorg/NeigeItems-Kotlin/releases

• You should download NeigeItems-xxx.jar (not NeigeItems-api), the file lager than 10MB.

• Install it in your server.

• All is done! Now plugin will auto display localized item name for now.

• Be careful: NeigeItems for now does not support 1.20.5 and higher version.