Introduction
Last updated Jul 6, 2026
Introduction
What is SoapsCommon?
SoapsCommon is not a gameplay plugin. It is a library that loads at server startup and gives every other Soaps plugin the same building blocks: formatted chat text, inventory menus, click actions, and optional hooks into Vault and PlaceholderAPI.
If you run any plugin from the Soaps suite (SoapsAdmin, SoapsQuest, SoapsTeleporter, and others), you need SoapsCommon installed first.
What it provides
- Startup checks so suite plugins can confirm the library is present before they enable
- GUI engine for YAML-driven inventory menus (used by SoapsAdmin, SoapsArena, SoapsQuest, and more)
- Text formatting with MiniMessage and legacy color codes
- Optional Vault bridge for economy calls from menu actions
- Optional PlaceholderAPI support when other plugins parse placeholders in messages
SoapsCommon does not add commands, permissions, or its own config.yml.
Shaded vs standalone
Most Soaps plugins ship with SoapsCommon code built inside their JAR. That is called a shaded build.
Some setups use a standalone SoapsCommon.jar in the plugins/ folder. In that case, every suite plugin that depends on it must list SoapsCommon under depend in plugin.yml.
Do not mix both on the same server. Pick one approach and keep all suite plugins on the same model.
Load order
SoapsCommon loads at STARTUP, before normal plugins. Suite plugins that depend on it will not enable if SoapsCommon is missing or disabled.
Typical install order:
- Paper server
- SoapsCommon (if using standalone)
- Any other Soaps plugins
Which plugins need it?
All eight suite plugins in this release set require SoapsCommon:
- SoapsAdmin
- SoapsArena
- SoapsFloor
- SoapsHungerStamina
- SoapsQuest
- SoapsTeleporter
- SoapsTraits
If a plugin fails to start with a message about a missing library, install or update SoapsCommon to match the version that plugin was built against.