Getting Started

Last updated Oct 28, 2026

Getting Started

Install SoapsAdmin 1.7.7 and confirm it loads.

Requirements

Requirement Details
Plugins SoapsCommon 2.0.x
Server Paper / Spigot 26.1, 26.2, 26.3 · Folia not supported
Java 21+ (Java 25 recommended)

Downloads are ZIPs. Extract the .jar into plugins/.

Soft deps (Vault, PAPI, Mythic, …): Soft Dependencies · Platform: Paper and Spigot.

Installation

  1. Download SoapsCommon and SoapsAdmin; extract both jars.
  2. Put jars in plugins/ and fully restart (not /reload).
  3. Confirm both plugins are green and plugins/SoapsAdmin/ was created.
  4. Run /sa version (expect 1.7.7) and /sa modules list.
Symptom Fix
Red plugin, no data folder JAR still inside a ZIP, or SoapsCommon missing
SoapsCommon green, Admin red Check logs/latest.log · Troubleshooting

First-run files

plugins/SoapsAdmin/
  config.yml
  modules.yml
  staff.yml
  teleport.yml
  server.yml
  player.yml
  economy.yml
  prices.yml
  messages.yml
  customcommands.yml
  gui.yml
  …

Full defaults: Config Reference

Admin path

  1. /sa admin — duty hub, Support Hub, server tools
  2. YAML — currencies, modules, warmups, shop prices
  3. /sa reload … — apply file edits

Prefer GUIs day-to-day; YAML for bulk lists and shop catalogs.

Reload policy

Change What to run
Most GUI edits Apply at runtime
YAML file edits /sa reload or /sa reload <target>
modules.yml /sa reload modules
gui.yml /sa guiconfig reload
storage.type / MySQL Full server restart
Jar upgrade / first install Full server restart (not /reload)

Tab-complete /sa reload for targets (config, teleport, economy, shop, messages, …).

Verify

/sa version
/sa modules list
/sa admin
/sa help
/sa info

Players with defaults: dashboard / home / warp only after you grant nodes (many plugin.yml player defaults are false in 1.7.7).

Common goals

Goal Page
Moderation ready Want moderation
Economy and shop Want economy
Homes, warps, TPA Want homes/warps/TPA
Top-level /home /give Want top-level commands
Staff mode Want staff mode
Lean modules Want lean modules

Next: Configuration · Upgrading to 1.7.7 · FAQ

Still stuck? Ask about this page