Shared essentials core (homes, warps, back, TPA, RTP) with tests; example configs

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

examples/README.md

@@ -0,0 +1,11 @@
+# Example configuration
+
+Copy the file for your setup and fill in `panel-url` and `token` (create the token under **Servers** in the admin panel).
+
+| Folder | Goes in | For |
+|---|---|---|
+| `paper/config.yml` | `plugins/SCOPENET/config.yml` | The Paper plugin. Includes the `integrations:` section for LuckPerms, PlaceholderAPI, Vault, CoreProtect, WorldGuard and Spark. |
+| `fabric-server/scopenet.properties` | `config/scopenet.properties` | The Fabric server mod (Fabric 1.20.1, 1.21.1). |
+| `fabric-client/scopenet-client.json` | `config/scopenet-client.json` | The optional Fabric client mod: HUD widgets, notifications and keybinds. |
+
+The client mod is display-only. The server mod or plugin stays in charge of claims, money and permissions, so a missing or edited client mod can't change anything.

examples/fabric-client/scopenet-client.json

@@ -0,0 +1,27 @@
+{
+  "_about": "SCOPENET client mod (Fabric 1.20.1) -> config/scopenet-client.json. The in-game config screen edits this file; you rarely need to change it by hand. The mod is in development and this format may grow.",
+  "enabled": true,
+  "hud": {
+    "scale": 1.0,
+    "opacity": 0.85,
+    "widgets": {
+      "balance":      { "enabled": true,  "anchor": "top_right",    "x": -8, "y": 8,   "compact": false },
+      "level":        { "enabled": true,  "anchor": "top_left",     "x": 8,  "y": 8,   "showXpBar": true },
+      "guild":        { "enabled": true,  "anchor": "bottom_left",  "x": 8,  "y": -8,  "showClaimOwner": true },
+      "quests":       { "enabled": false, "anchor": "middle_right", "x": -8, "y": 0,   "maxShown": 3 },
+      "claimBorders": { "enabled": true,  "showOnlyWhenSneaking": false }
+    },
+    "hideInF3": true,
+    "hideWhileChatOpen": false
+  },
+  "notifications": {
+    "levelUp": true,
+    "achievements": true,
+    "friendRequests": true,
+    "gameInvites": true
+  },
+  "keybinds": {
+    "openMenu": "key.keyboard.k",
+    "toggleHud": "key.keyboard.h"
+  }
+}

examples/fabric-server/scopenet.properties

@@ -0,0 +1,52 @@
+# SCOPENET for Fabric (server side)  ->  config/scopenet.properties
+# Works with the same panel as the Paper plugin. Keys marked [planned] are read once the Fabric
+# feature-parity work lands; unknown keys are ignored, so it is safe to keep them here.
+
+# --- Connection (required) ---------------------------------------------------
+# Your panel address and the token from Servers -> this server in the panel.
+panel-url=https://panel.example.com
+token=
+
+# --- Feature toggles (same meaning as the Paper plugin) ----------------------
+leveling.enabled=true
+leveling.global_xp_multiplier=1.0
+leveling.server_xp_multiplier=1.5
+quests.enabled=true
+achievements.enabled=true
+guilds.enabled=true
+guilds.land_claiming=true
+social.enabled=true
+social.chat_prefixes=true
+essentials.enabled=true
+economy.enabled=true
+
+# Send world chunks and player positions to the panel's Live Map
+# (also needs Live Map switched on for this server in the panel).
+livemap.enabled=true
+
+# --- Essentials [planned] ----------------------------------------------------
+# Homes, warps, /back, /tpa and /rtp. Same defaults as Paper.
+essentials.max_homes=5
+essentials.rtp_radius=2500
+essentials.tpa_timeout_seconds=60
+
+# --- Permissions [planned] ---------------------------------------------------
+# Uses the LuckPerms mod when it is installed (nodes are scopenet.command.*, same as Paper).
+# Without it, these defaults apply: "all" lets every player use the command, "op" limits to operators.
+permissions.default_level=all
+permissions.admin_commands=op
+
+# --- Economy mods [planned] --------------------------------------------------
+# auto   : use the first supported economy mod found (Impactor, Common Economy API), else SCOPENET's own balances
+# scopenet: always use SCOPENET balances (other mods can still read them through the SCOPENET API)
+economy.provider=auto
+economy.currency_symbol=$
+
+# --- Placeholder API [planned] -----------------------------------------------
+# Registers %scopenet:level%, %scopenet:guild%, %scopenet:balance%, %scopenet:playtime%,
+# %scopenet:quest_progress% when Placeholder API (Fabric) is installed.
+placeholders.enabled=true
+
+# --- Client mod link [planned] -----------------------------------------------
+# Send balance, level and guild info to players who have the SCOPENET client mod.
+clientlink.enabled=true

examples/paper/config.yml

@@ -0,0 +1,96 @@
+# SCOPENET Paper plugin  ->  plugins/SCOPENET/config.yml (this is a copy of the file the plugin creates on first start)
+# ==============================================================================
+# SCOPENET Minecraft Server Configuration
+# ==============================================================================
+# 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.
+
+panel-url: "https://panel.example.com"
+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.
+# ==============================================================================
+
+leveling:
+  # Global & Server leveling progression (tracks playtime, kills, mining, etc.)
+  enabled: true
+  # Multiplier for account-wide Global Level XP (1.0 = standard speed)
+  global-xp-multiplier: 1.0
+  # Multiplier for this server's specific Server Level XP (1.5 = 1.5x speed)
+  server-xp-multiplier: 1.5
+
+quests:
+  # Daily and Weekly quests progression tracking
+  enabled: true
+
+achievements:
+  # Minecraft-themed achievements and milestone unlock notifications
+  enabled: true
+
+guilds:
+  # Guilds partying system and /guild commands
+  enabled: true
+  # FTB Chunks-style chunk land-claiming and protection against other guilds
+  land-claiming: true
+  # Allow guild members to damage each other (PvP friendly fire)
+  friendly-fire: false
+
+social:
+  # Friends status, direct messaging bridge, and server game invites
+  enabled: true
+  # Show player guild tag and level title in chat formatting
+  chat-prefixes: true
+
+essentials:
+  # Essentials commands (/spawn, /home, /sethome, /delhome, /back, /tpa, /tpaccept, /tpdeny, /rtp, /warp, /playtime)
+  enabled: true
+  # Maximum homes per player
+  max-homes: 5
+  # RTP search radius
+  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.
+  enabled: true
+
+economy:
+  # Server Economy commands (/balance, /pay, /baltop, /shop, /sell, /market, /orders, /trade, /transactions)
+  enabled: true
+  # Currency symbol
+  currency-symbol: "$"
+
+
+# ==============================================================================
+# Plugin integrations
+# SCOPENET detects these plugins by itself; switch any of them off here.
+# ==============================================================================
+integrations:
+  luckperms:
+    enabled: true
+    # Send each online player's LuckPerms rank to the panel (profiles, admin view).
+    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.
+    apply-panel-groups: false
+  placeholderapi:
+    # %scopenet_level%, %scopenet_guild%, %scopenet_balance%, %scopenet_playtime%, %scopenet_quest_progress% ...
+    enabled: true
+  vault:
+    # Use the SCOPENET economy as Vault's economy, so other plugins' shops and jobs pay into it.
+    enabled: true
+  coreprotect:
+    enabled: true
+    # Folders scanned for world backups shown in the panel.
+    backup-folders:
+      - backups
+  worldguard:
+    enabled: true
+    report-interval-minutes: 5
+  spark:
+    enabled: true
+    report-interval-seconds: 30