Skip to content

Admin Guide

Sauron_Dev edited this page May 4, 2026 · 1 revision

Admin Guide

VortexRPG includes in-game tools for managing content, diagnostics, integrations, and smart systems.

Main Admin Entry Points

/vortex
/vrp admin

Use /vortex for admin toolkit access and /vrp admin if you want to stay under the unified command hub.

Smart System Admin Commands

Command Permission Purpose
/vortex director vortex.admin.smart Shows Vortex Director pressure, counters, multipliers, and recommendation
/vortex brain vortex.admin.smart Alias for Director status
/vortex affixes vortex.admin.smart Shows relic affix roll state and available affixes
/vortex mutators vortex.admin.smart Shows mutator roll state and active mutators
/vortex synergies vortex.admin.smart Lists class synergy combos
/vortex codex vortex.admin.smart Shows codex system status
/vortex reputation vortex.admin.reputation Shows faction status and usage help
/vortex reputation <player> <faction> <amount> vortex.admin.reputation Adjusts reputation manually

Content Editing

VortexRPG includes forge-style tools for editing RPG content in game.

Common areas include:

  • Classes
  • Spells
  • Effects
  • Items
  • Bosses
  • Dungeons

Use the dedicated command for each system or open /vortex to inspect available admin actions.

Hot Reloads

Several registries support reload commands so admins can iterate without a full server restart.

Examples:

/vortex reloadspells
/vortex reloadeffects
/vortex reloaditems
/vboss reload
/vdungeon reload

Diagnostics and Support Dumps

VortexRPG includes diagnostics and support-dump tooling for server debugging.

Support dumps are configured under:

support:
  dump-directory: support
  redact-paths:
    - mongodb.uri
    - redis.uri
    - npc.api-key

Use support dumps when reporting issues so sensitive paths and secrets can be redacted.

Recommended Admin Setup Flow

  1. Install the correct jar and start the server once.
  2. Open /vrp about to confirm version and links.
  3. Review generated config files.
  4. Assign player permissions or use vortex.player for general access.
  5. Assign vortex.admin and more specific admin nodes only to trusted staff.
  6. Configure optional integrations like Vault, PlaceholderAPI, WorldGuard, and Citizens.
  7. Test class selection, spell casting, stats, dungeons, and smart progression commands.
  8. Run diagnostics or validation tools before public release.

Common Admin Checks

Check Command
Confirm plugin version /vrp about
Inspect command hub /vrp help
Inspect Director state /vortex director
Inspect affixes /vortex affixes
Inspect dungeon mutators /vortex mutators
Inspect codex system /vortex codex
Inspect faction IDs /vortex reputation

Clone this wiki locally