Welcome to the Hangar Open Beta. Please report any issue you encounter on GitHub!
Avatar for Vystorm

Shared base for Vystorm plugins: main menu, settings, in-game config editor, admin dashboard, update check.

Report Vystorm-Core?

Free base for all Vystorm plugins. Install it first.

Vystorm Core

One main menu, one settings screen and one admin dashboard for every Vystorm plugin on your server.

All other Vystorm plugins run on Vystorm Core. It gives players one menu for everything that is installed, and it gives you one place to configure, translate and update all of it.

Vystorm Core banner

What players get

  • One menu for every installed plugin: /vmenu.
  • Menus that open as clickable screens in their view, without a client mod.
  • Every text in their own language, chosen from seven with /language.
  • A profile card, an inbox for things that happened while they were offline, and the server news.
  • Sneak and right-click another player to see what they can do with them.

Features

Menus for players

  • Open every plugin's menu from one main menu with /vmenu: categories, a search, up to 20 favourites and the last eight menus.
  • Use the button in the pause menu on servers with native dialogs. The shortcut sneak and left-click twice is off by default; switch it on with menu.sneak-click-shortcut.
  • Vystorm Screens draw menus, chest menus, dialogs and tutorials as tiles, buttons, tabs and lists in the player's view, with a mouse pointer and a Back button. Menus where items really move stay real chests, protected however they are shown, and a click on a screen never reaches the block behind it.
  • Change personal options of all plugins in /vsettings, and pick a language with /language (seven languages ship with Core; by default a player gets their Minecraft language).
  • Sneak and right-click a player with an empty hand for the player menu with the actions your plugins offer (pay, invite, view stats).
  • Look at a profile card with /vmenu profile, read the inbox with /vmenu inbox (for things that happened offline) and the news with /vmenu news. New posts show once on join.
  • Vote in server polls with /vpoll, and read a tutorial for each plugin under /vmenu tutorials, with build GIFs and an optional first-steps guide.
  • List every command a player may use, in their language, with /vhelp.
  • Write in the trade channel with /vtrade <message>, and click coordinates in chat (staff teleport there).

The main menu as a tile screen with one tile per plugin

Your own menus and placeholders

  • Design menus in the browser with the menu editor on vystorm.net, save the file, put it into plugins/vystorm_core/menus/ and load it with /vadmin menus reload. A menu opens with /vmenu <id> or a command of its own. Buttons run commands, send messages or open other menus, with a permission and a cooldown per click. /vadmin menus lists the files and what is wrong with a skipped one. Give console commands in a menu a permission or cooldown.
  • One place for the values of all Vystorm plugins: %vystorm_<namespace>_<key>%, for example %vystorm_core_online%. When PlaceholderAPI is installed, Core passes them on to PlaceholderAPI, so scoreboards, tab lists and chat formats can show them. /vadmin placeholders lists every value, and /vadmin placeholders test <text> previews a text. Inserted values stay plain text.

Administration

  • Edit any plugin's config.yml in game with /vadmin config <plugin>. Core backs up before the first save, and /vadmin config history shows who changed which value and puts it back with one click.
  • Switch features of every plugin on and off on one screen: /vadmin features.
  • Run each plugin's common admin actions as buttons in /vadmin, change options of several plugins together in /vsettings draft, and let the setup wizard apply a few answers after a new install (/vadmin setup).
  • Get a line on join when a Vystorm plugin has a newer version; /vadmin updates lists them.
  • Write news posts in game and start polls with /vpoll start 120 Question | Answer A | Answer B. Find missing translations with /vadmin language audit.
  • Find out why something does not work: /vadmin diagnostics <player>, /vmenu access <player> and /vadmin trace, which names the plugin that cancelled an action.
  • Hover a chat line sent through Core to see which plugin sent it. /vadmin screens chooses which menus stay chests or dialogs.

A plugin config opened in the in-game config editor

Shared services for the plugins

  • Plugin worlds and visits: before a player enters a plugin's own world, Core saves inventory and state and gives them back on exit, disconnect, server stop or after a crash (/vworlds).
  • Shared database: all Vystorm plugins can use one MySQL or MariaDB database.
  • Loot tables: one set of loot lists for all plugins in loot-*.yml, with /vadmin loot to preview rolls.
  • Event order: event-order decides which plugin handles a block break or click first.
  • Region register: /vregion shows the regions all plugins registered.
  • Web panel (off by default): /web sends a player a one-time login link to the server's web pages.
  • Client mod support: players with the optional Vystorm client mod get native screens, HUD bars and toasts.
  • Network hub (experimental): behind Velocity or BungeeCord, a player list, a server selector and broadcasts across servers (/vnet).
  • Resource pack: Core hosts and sends its small pack, which gives pinned screens their mouse pointer.

A player returning from a plugin world with the inventory restored

Switch features on and off

Every feature of Core except the ones named below has its own switch in config.yml and in game under /vadmin features. A switched-off feature answers "This feature is switched off on this server." and disappears from tab completion and menus. Changes apply at once; only metrics, everything under web and everything under database need a restart.

Core is the base of the other plugins, so it has no switch for the main menu, the settings screen, the config editor, the feature screen, the admin dashboard, the language system with its translation tools, /vhelp with the localized commands, the event order and the placeholder manager. The other plugins are built on them. Loot tables, the inventory handling of plugin-world visits and the region register keep working for the plugins; loot.enabled, plugin-worlds.enabled and region-register.enabled only turn off Core's own commands and extras. Four things are switched outside the feature screen: the pause-menu button under /vsettings server, the resource pack in resource-pack.yml, the shared database in the file, and the network hub with network.enabled: false.

Setup

  1. Put the jar into plugins/ and start the server. Core loads before the other plugins.
  2. On the first start the server downloads the libraries Core declares, so it needs internet access once.
  3. Add the Vystorm plugins you want. Never install two Core jars.

Core comes preconfigured and works after the first start. All texts ship in seven languages. You edit the config in game with /vadmin config vystorm_core.

Compatibility: tested on Paper and Purpur 26.2, Paper 1.20.6 and Spigot 26.2. Java 21 or newer (Java 25 on 26.x servers). On servers without native dialogs, menus and forms use clickable chat. Optional: Vault, for plugins that use an economy.

Commands and permissions

/vmenu, /vsettings, /language, /vhelp, /vpoll, /vtrade and /web are for everyone. /vadmin, /vregion and /vworlds need vystorm_core.admin (OP), which includes vystorm_core.config.<plugin> and vystorm_core.news.write. The full tables are in the README on GitHub.

Good to know: Core sends anonymous bStats data about which Vystorm plugins run in which versions (switch off with metrics: false). After 7 days with a Vystorm plugin, the next admin who joins gets one message with a review link; review-reminder.enabled switches it off.

Vystorm Core gets at least one update every month. If it does its job on your server, a review helps other server owners find it.

For developers: Core has a public API. The documentation is in the GitHub repository.

More from Vystorm

Vystorm Rails, VystormPortals, CustomTrees, XPVaultEconomy, BlockIntegrations, Vystorm Veins, Winter Is Coming, Vystorm Insomnia, Vystorm Gallery, Vystorm Paddock, Vystorm Snapshot, Vystorm Boards, Vystorm Estates, Vystorm Chat, Vystorm Worlds and Vystorm Locks, all free.

Free and open source (LGPL-3.0): source code on GitHub

Information

Category
Developer Tools
Published
October 29, 2026
License
MIT
99Downloads
2Stars
Library

Pinned Versions

Members

1