Docs: full Vantage 3D map setup guide; fully commented Paper example config

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DjMbLQujBHunCCu5GpsHaT

examples/paper/config.yml

@@ -1,96 +1,125 @@
-# SCOPENET Paper plugin  ->  plugins/SCOPENET/config.yml (this is a copy of the file the plugin creates on first start)
 # ==============================================================================
-# SCOPENET Minecraft Server Configuration
+# SCOPENET Paper plugin  ->  plugins/SCOPENET/config.yml
+# Fully commented example. Every key shown here is read by the plugin; the values
+# are the defaults. Remove anything you don't want to change.
+# Requires Paper 1.20+ and online-mode=true in server.properties.
 # ==============================================================================
-# Connect to your SCOPENET Panel instance by pasting your server token below.
-# Create a server under 'Servers' in the web panel to generate a token.
 
+# --- Connection (required) ----------------------------------------------------
+# The panel's address, with no trailing path. Use the address players and servers
+# can reach, normally the same HTTPS address you set as the panel's Public address.
 panel-url: "https://panel.example.com"
+
+# The server token. In the panel: Servers -> your server -> Generate token.
+# It starts with "sn_". Keep it secret; anyone with it can act as this server.
 token: ""
 
 # ==============================================================================
-# Feature Toggles
-# Every system below is fully toggleable. You do not need to force all features
-# on every server—turn on only what makes sense for your server's gameplay style.
+# Feature toggles
+# Turn off anything you don't want on this server. Changing a value needs
+# "/scopenet reload" or a restart. The panel can still switch features off for you.
 # ==============================================================================
 
 leveling:
-  # Global & Server leveling progression (tracks playtime, kills, mining, etc.)
+  # Global and per-server levels, earned from playtime, kills, mining and more.
   enabled: true
-  # Multiplier for account-wide Global Level XP (1.0 = standard speed)
+  # Speed of the account-wide Global Level. 1.0 is normal, 2.0 is double.
   global-xp-multiplier: 1.0
-  # Multiplier for this server's specific Server Level XP (1.5 = 1.5x speed)
+  # Speed of this server's own Server Level. Higher than global by default so
+  # a server's level feels alive.
   server-xp-multiplier: 1.5
 
 quests:
-  # Daily and Weekly quests progression tracking
+  # Daily and weekly quests. How many are offered is set in the panel
+  # (Progression -> Quest limits).
   enabled: true
 
 achievements:
-  # Minecraft-themed achievements and milestone unlock notifications
+  # Achievement tracking and unlock notifications.
   enabled: true
 
 guilds:
-  # Guilds partying system and /guild commands
+  # Guilds, /guild commands, the guild bank and guild market.
   enabled: true
-  # FTB Chunks-style chunk land-claiming and protection against other guilds
+  # Guild land claims. Other players can't build or break in a claimed chunk
+  # unless they are in that guild (or have scopenet.claims.bypass).
+  # Claims are checked against a local copy that refreshes from the panel, so
+  # breaking blocks never waits on the network.
   land-claiming: true
-  # Allow guild members to damage each other (PvP friendly fire)
+  # Let guild members hurt each other.
   friendly-fire: false
 
 social:
-  # Friends status, direct messaging bridge, and server game invites
+  # Friends, direct messages and game invites.
   enabled: true
-  # Show player guild tag and level title in chat formatting
+  # Show guild tag and level title in chat.
   chat-prefixes: true
 
 essentials:
-  # Essentials commands (/spawn, /home, /sethome, /delhome, /back, /tpa, /tpaccept, /tpdeny, /rtp, /warp, /playtime)
+  # /spawn /home /sethome /delhome /back /tpa /tpaccept /tpdeny /rtp /warp /playtime
   enabled: true
-  # Maximum homes per player
+  # Homes per player.
   max-homes: 5
-  # RTP search radius
+  # /rtp picks a random safe spot within this many blocks of 0,0.
   rtp-radius: 2500
 
 livemap:
-  # Send world chunks and live player positions to the panel's central Live Map.
-  # Players open it from the launcher; you don't run Vantage on this server.
-  # It also needs "Live Map" switched on for this server in the panel.
+  # Send world chunks and player positions to the panel's central 3D Live Map.
+  # Nothing runs on this server; the panel renders it. Needs "Live Map" switched on
+  # for this server in the panel, and Vantage installed on the panel.
+  # Setup guide: docs/vantage-setup.md
   enabled: true
 
 economy:
-  # Server Economy commands (/balance, /pay, /baltop, /shop, /sell, /market, /orders, /trade, /transactions)
+  # /balance /pay /baltop /shop /sell /market /orders /trade /transactions
   enabled: true
-  # Currency symbol
+  # Shown next to amounts.
   currency-symbol: "$"
 
-
 # ==============================================================================
-# Plugin integrations
-# SCOPENET detects these plugins by itself; switch any of them off here.
+# Optional plugin integrations
+# SCOPENET finds these plugins by itself. Switch one off here if you don't want it.
+# "/scopenet status" shows which are active.
 # ==============================================================================
 integrations:
   luckperms:
     enabled: true
-    # Send each online player's LuckPerms rank to the panel (profiles, admin view).
+    # How often each online player's LuckPerms rank is sent to the panel, which
+    # shows it on profiles and the server page.
     report-interval-seconds: 60
-    # Let the panel add/remove LuckPerms group membership for groups an admin has mapped to a panel
-    # group (Panel > Players > Groups). LuckPerms stays in charge of permissions; this is off unless you opt in.
+    # Let the panel add or remove LuckPerms groups for players, for groups an admin
+    # mapped in Panel -> Players -> Groups. LuckPerms still decides real permissions.
+    # Off by default: turn it on only when you want panel groups to change ranks here.
     apply-panel-groups: false
   placeholderapi:
-    # %scopenet_level%, %scopenet_guild%, %scopenet_balance%, %scopenet_playtime%, %scopenet_quest_progress% ...
+    # Adds %scopenet_level%, %scopenet_guild%, %scopenet_balance%, %scopenet_playtime%,
+    # %scopenet_quest_progress% and more for scoreboards, tab lists, holograms and chat.
     enabled: true
   vault:
-    # Use the SCOPENET economy as Vault's economy, so other plugins' shops and jobs pay into it.
+    # Make SCOPENET's economy the Vault economy, so shop, jobs and other plugins
+    # use the same balances.
     enabled: true
   coreprotect:
+    # Show logging activity and backup status in the panel.
     enabled: true
-    # Folders scanned for world backups shown in the panel.
+    # Folders (relative to the server folder) checked for world backups.
     backup-folders:
       - backups
   worldguard:
+    # Show WorldGuard regions, including server-owned territory, in the panel.
     enabled: true
     report-interval-minutes: 5
   spark:
+    # Show TPS, MSPT, CPU and memory in the panel.
     enabled: true
     report-interval-seconds: 30
+
+# ==============================================================================
+# Permissions (set these in LuckPerms, not here)
+#   scopenet.command.<command>             e.g. scopenet.command.home
+#   scopenet.command.guild.*               every /guild subcommand
+#   scopenet.command.*                     everything
+#   scopenet.claims.bypass                 build in other guilds' claims (staff)
+#   scopenet.admin                         /scopenet status and reload
+# All nodes are listed in the plugin's plugin.yml.
+# ==============================================================================