đĒ Integrations
We have created our AxIntegrations library, which allows us to support third party plugins across all of our resources.
If you are a developer, feel free to open a pull request adding an integration to your plugin. If you are adding a paid plugin, and it isn't an api only jar, make sure to turn it into an empty (stub) jar first.
Note that it is almost impossible trying to keep all of these hooks up to date, so if you notice any issues with any of the integrations, please report them!
You don't have to download anything as AxIntegrations is included in our plugin jars.
Where are these integrations used?
â
- this plugin is using this system
â - this plugin doesn't use this integration
Plugin | Backpack | Bank | Container | Currency | Custom Block | Level | Protection | Shop | Stacker | Team | Vanish |
|---|---|---|---|---|---|---|---|---|---|---|---|
AxSellChests | â | â | â | â | â | â | â | â | â | â | â |
AxSpawners | â | â | â | â | â | â | â | â | â | â | â |
Supported Plugins
The list of supported plugins by each category. Next to the plugin name you can find the creator's username, so you figure out which exact plugin is supported.
Click on the category to open the list of supported plugins!
Backpack
...
Bank
BentoBox (BentoBoxWorld) - â ī¸ requires bank addon
KingdomsX (CryptoMorin)
SuperiorSkyblock2 (Ome_R)
Container
AxShulkers (Artillex-Studios) [modrinth]
Currency
AxHoes (Artillex-Studios) [builtbybit] [spigot]
AxPickaxes (Artillex-Studios) [builtbybit]
AxQuestBoard (Artillex-Studios) [builtbybit] [spigot]
BeastTokens (MrAxeTv)
CoinsEngine (NightExpress) - â ī¸ replaced by ExcellentEconomy
EcoBits (Exanthiax)
ExcellentEconomy (NightExpress)
PlayerPoints (Esophose)
RivalCredits (RivalDevelopment)
RivalHarvesterHoes (RivalDevelopment)
RivalMobSwords (RivalDevelopment)
RoyalEconomy (qKing)
SuperMobCoins (Swanis)
TokenManager (Realized)
UltraEconomy (TechsCode)
Vanilla Minecraft Experience
Vanilla Minecraft Level
Vault (Sleaker)
Custom Block
ItemsAdder (LoneDev)
Nexo (Boy0000)
Oraxen (Uxon)
Level
AxGens (Artillex-Studios) [builtbybit] [spigot]
AxHoes (Artillex-Studios) [builtbybit] [spigot]
AxPickaxes (Artillex-Studios) [builtbybit]
Protection
BentoBox (BentoBoxWorld)
ExcellentClaims (NightExpress)
HuskClaims (William278)
HuskTowns (William278)
IridiumSkyblock (Peaches_MLG)
KingdomsX (CryptoMorin)
Lands (Angeschossen)
PlotSquared (IntellectualSites)
SuperiorSkyblock2 (Ome_R)
Towny (TownyAdvanced)
WorldGuard (EngineHub)
Shop
AxGens (Artillex-Studios) [builtbybit] [spigot]
CMI (Zrips)
EconomyShopGUI (Gypopo) - âšī¸ both the free and the premium versions are supported
EssentialsX (md678685)
ExcellentShop (NightExpress)
ShopGUIPlus (brc-plugins)
zShop (Maxlego08)
Stacker
AxStacker (Artillex-Studios) - â ī¸ not released
RoseStacker (Esophose)
SuperiorSkyblock2 (Ome_R) - âšī¸ only block stacking is available
WildStacker (Ome_R)
Team
...
Vanish
EssentialsX (md678685)
PremiumVanish (MyzelYam)
SuperVanish (MyzelYam)
For Developers
How to add an integration using the AxIntegrations api?
AxIntegrations is shaded and relocated into our plugins, so you must add the plugin's api jar into your project. See the specific plugin's developer api page for more information.
Create your own integration class. Your class should extend one of these type classes. Check the comments on the type classes for more information on how you should create your own.
Create a AxIntegrationsLoadEvent listener and register it in your plugin.
In the listener, use the AxIntegrationsAPI provideIntegration (or registerIntegration) method to register your integration. Which method should you use?
provideIntegration | Adds the integration the same way as one of the builtin ones. It won't get automatically loaded, the user will have to manually select/enable your plugin for it to work. This is a safe and great way to register third party integrations in public plugins, so users aren't forced to use them. |
|---|---|
registerIntegration | Automatically registers the integration without checking if the user have enabled it. Note that it can cause issues if the plugin only requires one of the integration type (for example if only one currency type is used) and if you registered a second one, it can break the plugin. |
Don't forget to add the plugin that you are adding your integration to into your plugin.yml's
dependorsoftdependlist!
Full example
In this example I will show a full working example creating a currency integration named
TestIntegrationand adding it to AxSpawners.
Add api jar into pom.yml (important: set the scope to
providedso we are not including the api jar into our plugin)
Add AxSpawners into the
softdependlist:
Create our CurrencyIntegration
Register the listener and integration. (note: if your integration class requires a listener or something else, you will have to do that yourself in the setup section)
Go to the plugin and enable the integration. Some integrations in some plugins are on by default. For example in AxSpawners → hooks.yml
And that's it, now you should see it registered after restarting:
[AxSpawners] Loaded currency integrations: TestIntegration-mycurrency.