Skip to content

Incompatible plugins #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 of 4 tasks
NonSwag opened this issue Mar 13, 2025 · 0 comments
Open
1 of 4 tasks

Incompatible plugins #62

NonSwag opened this issue Mar 13, 2025 · 0 comments
Assignees
Labels
help wanted Extra attention is needed incompatibility A plugin that does not work with ServiceIO

Comments

@NonSwag
Copy link
Member

NonSwag commented Mar 13, 2025

This is a tracking issue to list all known plugins that are not compatible for various reasons

Common reasons for a plugin not recognizing ServiceIO as Vault

  • Iterating all loaded plugins and using Plugin#getName to check for Vault
  • Using Class#forName to check for the presence of Vault internal classes

Proper way to make your plugin recognize ServiceIO as Vault

  • Use PluginManager#isPluginLoaded("Vault")
  • Use PluginManager#getPlugin("Vault") != null
  • When using Plugin#getName also check PluginMeta#getProvidedPlugins
  • Avoid Class#forName or at least only do so on API class names and not internal ones
  • If Vault is not optional for your plugin, don't incorporate any checks and just use the API

Why this happens

  1. Since ServiceIO only provides the VaultAPI it doesn't come with the same packages and classes as the Vault-Plugin, so class name checks will fail when testing for Vault-internal classes.
  2. When improperly testing for Vault by its name, there won't be any matching results available, since the ServiceIO Plugin is not named Vault for somewhat obvious reasons.

How you as a user can temporarily resolve that problem for yourself

  1. Open the jar file of ServiceIO with a zip extractor
  2. Open the paper-plugin.yml in a text editor
  3. Change name from ServiceIO to Vault
  4. Replace Vault with ServiceIO under provides

The changes you made should look like this:
Image

Note: This is not an issue directly caused by ServiceIO and should be addressed in other plugins


A list of all known incompatible plugins

  • CMI
  • Eco
  • QuickShop-Hikari
  • Towny
@NonSwag NonSwag added the help wanted Extra attention is needed label Mar 13, 2025
@NonSwag NonSwag self-assigned this Mar 13, 2025
@NonSwag NonSwag modified the milestone: World domination (no one uses vault anymore) Mar 13, 2025
@NonSwag NonSwag pinned this issue Mar 13, 2025
@NonSwag NonSwag added the incompatibility A plugin that does not work with ServiceIO label Mar 13, 2025
@TheNextLvl-net TheNextLvl-net locked and limited conversation to collaborators Mar 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
help wanted Extra attention is needed incompatibility A plugin that does not work with ServiceIO
Projects
None yet
Development

No branches or pull requests

1 participant