Integrations

SoapsCommon (Required)

Item	Detail
Dependency	Hard depend in plugin.yml
Purpose	GUI engine, MiniMessage helpers, startup checks, animated menus
Behavior	SoapsCommon.require(this) on enable: SoapsAdmin disables if missing

Shared config keys follow SoapsCommon conventions (e.g. settings.debug in config.yml).

Platform: Paper and Spigot

SoapsAdmin targets Paper and Spigot 26.2 (tested on Paper 26.2, Java 25). Folia is not supported. Paper is recommended (smoother RTP/teleport chunk preload, owner-only waypoint displays, MySQL library loader).

Paper-only

Feature	Notes
Item editor	Data-component / advanced editing
Fake players / mannequins	Paper Mannequin API
Waypoint owner-only visibility	On Spigot, markers are public
Paper libraries: MySQL jars	Spigot may fall back to SQLite or flatfile with a console warning

Works on Spigot

Area	Notes
Moderation, staff tools, chat filters	Full
Economy, shop, kits, recipes, cheques	Vanilla + Mythic/Crucible refs when Mythic is present
Teleports, homes, warps, RTP, TPA	Claim hooks when claim plugins are present
RTP / teleport chunk preload	Sync load fallback via ChunkLoadHelper (Paper uses async)
/sa spawnmob, /sa killall	Including Mythic when MythicMobs is present
Vault, PlaceholderAPI	Soft deps
Adventure / MiniMessage	Shared on modern Spigot 1.21

On Spigot, Paper-only modules refuse with a clear message. See FAQ and Item Editor.

Vault (Optional)

Item	Detail
Soft dependency	Vault
Config	economy.yml → vault-integration: true
Primary economy	primary-economy: money (or your currency id)

Registers the primary SoapsAdmin economy with Vault. Kit costs and other Vault consumers use that primary currency. Without Vault, built-in economy, shop, and drops still work inside SoapsAdmin.

PlaceholderAPI (Optional)

Item	Detail
Soft dependency	PlaceholderAPI
Expansion	soapsadmin

See Placeholders. Registered automatically when PAPI is present. Includes Mythic status placeholders when MythicMobs is loaded.

LuckPerms and permission plugins

SoapsAdmin does not call the LuckPerms API. Any Bukkit permissions plugin works through standard hasPermission checks, including context-aware nodes.

Grant nodes such as soapsadmin.kit.<name> or soapsadmin.home.limit.<n> in LuckPerms (or equivalent). See Permissions.

MythicMobs and MythicCrucible (Optional)

Item	Detail
Soft dependencies	MythicMobs, MythicCrucible
Bridge	Soft reflection (MythicBridge): no compile-time Mythic JAR

Console logs MythicMobs / MythicCrucible availability and mob/item counts on enable. Commands that need Mythic fail with integrations.mythic-required when the bridge is offline.

Feature matrix

Feature	MythicMobs	MythicCrucible
/sa spawnmob mythic:Id + tabs	Required	-
/sa killall mythic / mythic:Id	Required	-
Spawner Mythic type picker + soft spawn	Required	-
Economy mobs.mythicmobs.<InternalName> drops	Required	-
Recipe crucible: / mythic: / mm: ExactChoice	Helpful	Required for Crucible packs
/sa give crucible:ItemId	Helpful	Required for Crucible items
Kits material: crucible:...	Helpful	Required for Crucible items
Shop / prices.yml keys crucible:ItemId	Helpful	Required for Crucible items
Daily reward item refs	Helpful	Required for Crucible items
PAPI %soapsadmin_mythic_loaded%, %soapsadmin_mythic_mobs%	Required for non-zero	-

Prefixes: crucible:, mythic:, mm:. See Recipes, Spawners, and Economy and Shop.

Out of scope

Mythic skill casting, in-game Mythic pack editing, and compile-time Mythic API usage are not supported.

Claim plugins (Optional)

Soft reflection for WorldGuard, Lands, and GriefPrevention. WorldEdit is listed as a softdepend only so WorldGuard adapters load cleanly.

Config (teleport.yml):

teleportation:
  claims:
    enabled: true
    block-rtp-in-claims: true
    block-set-in-claims: true
    allow-friends: true

Check	Behavior
RTP destination	Reject candidates inside foreign claims/regions
Set home / set warp	Block when the player cannot build there
Teleport to home / warp / friend / TPA dest	Block when the destination is forbidden
Bypass	soapsadmin.teleport.bypass-claims (also soapsadmin.teleport.bypass)
Friends exception	When allow-friends: true, allow if the claim owner is a SoapsAdmin friend

Double-doors claim checks use the same ClaimService.

WorldGuard currency-drop flag

When WorldGuard is present, SoapsAdmin registers a custom region flag soapscurrency (default ALLOW).

Flag state	Effect
ALLOW (default)	Mob currency drops work as usual
DENY	No SoapsAdmin mob currency in that region

Example:

/rg flag <region> soapscurrency deny

No-op when WorldGuard is absent. See Economy and Shop.

mcMMO (Optional)

Item	Detail
Soft dependency	mcMMO
Master toggle	integrations.mcmmo.enabled in config.yml
Share settings	player.yml → friends.mcmmo-xp-sharing*

When the master toggle is on and the friends module is enabled, McMMO skill XP gains share a configured fraction with nearby SoapsAdmin friends.

# config.yml
integrations:
  mcmmo:
    enabled: true

# player.yml
friends:
  mcmmo-xp-sharing: true
  mcmmo-xp-sharing-radius: 10.0
  mcmmo-xp-sharing-percent: 100.0

Citizens (Optional)

Item	Detail
Soft dependency	Citizens
Economy	Entities with metadata NPC count as custom mobs

With mob-drops.custom-mobs.vanilla-only: true, Citizens NPCs never drop SoapsAdmin currency.

Load Order

loadbefore: [MMOCore, MMOItems, MythicLib, ChatControl, ChatControlRed, ChatControl-Red, VentureChat, EssentialsChat, DeluxeChat, CarbonChat, Chatty, TownyChat, HuskChat, AdvancedChat]
softdepend: [Vault, PlaceholderAPI, LuckPerms, MythicMobs, MythicCrucible, Citizens, WorldGuard, WorldEdit, Lands, GriefPrevention, mcMMO, ChatControl, ChatControlRed, ChatControl-Red, VentureChat, EssentialsChat, DeluxeChat, CarbonChat, Chatty, TownyChat, HuskChat, AdvancedChat]

SoapsAdmin initializes before MMOCore/MMOItems/MythicLib and common chat plugins when those are present (helps staff chat prompts stay private).

Permissions use standard Bukkit hasPermission (works with LuckPerms via Vault). No LuckPerms-specific API is required; softdepend is for load order/docs only.

MySQL Storage

storage:
  type: mysql
  mysql:
    host: localhost
    port: 3306
    database: soapsadmin
    username: root
    password: ""
    table-prefix: sa_

Uses HikariCP from Paper's library loader when available. On Spigot, if Paper libraries fail to load, SoapsAdmin falls back to SQLite, then flatfile, with a console warning. For multi-server networks that share punishments and economy data, prefer Paper with storage.type: mysql.

Custom Commands vs Other Plugins

When register-all-commands: true, SoapsAdmin registers top-level commands and uses /soapsadmin:<name> as fallback if another plugin already owns a name.

Checking Integrations at Runtime

/sa info
/sa version
/sa pm list
/papi list

/sa health shows TPS, memory, and entity counts.