Skip to content

The staff web panel

ShottyCore serves a staff web panel from the proxy itself (module web-panel), using the JDK’s built-in web server: no extra web server and no database of its own beyond ShottyCore’s. Pages update live as things happen in game, and every action taken on it lands in the audit log.

Set it up as in Getting started: a reverse proxy with HTTPS in front of web-panel.port, and web-panel.public-url set to the address staff use.

Staff sign in with their Minecraft name, a password and a code from an authenticator app. Both are required for everyone.

  1. In game, /panel login gives a one-time link (and a six-digit code, for a browser on another device). It works once, for five minutes.
  2. The first time, the link opens the set-up: choose a password (12 characters or more), scan a QR code with an authenticator app, and keep the ten recovery codes.
  3. After that, staff sign in at the panel’s address from anywhere, in game or not.

A browser stays signed in while it is used: it is signed out web-panel.session-days (30) after its last visit and session-max-days (90) after the sign-in at the latest. Ticking shared computer makes it session-hours (12).

  • A forgotten password: /panel login again stands in for it. It never stands in for the authenticator, so a stolen game account alone opens nothing. A recovery code stands in for the authenticator once.
  • Five wrong passwords or codes in 15 minutes lock a name for 15 minutes, and its owner is told in game.
  • Someone who lost everything is reset by an admin on the Staff team page (shottycore.accounts) or with panel reset <name> in the proxy console, and sets up again from the game.
  • /panel logout signs out every browser.

Access follows the same LuckPerms nodes as in game, re-checked every minute. shottycore.panel lets someone sign in at all; each page needs its own node.

Passwords are stored as PBKDF2 hashes, link tokens and recovery codes as hashes, and authenticator secrets sealed with a key kept in panel.secret beside config.yml. Keep that file, and companion-link.secret, readable by the proxy’s user only.

Section Page Permission What it does
Dashboard shottycore.panel What is waiting for staff (reports, tickets, appeals, flagged messages, your tasks) and the network at a glance.
Moderation Reports shottycore.report.manage The report queue: claim, jump to the player, punish, close.
Tickets shottycore.ticket.manage Support tickets as a conversation, answered from the panel or in game.
Appeals shottycore.appeals Ban appeals from the public form; accepting lifts the punishment.
Flagged shottycore.monitor Messages that matched the watched words, with the conversation around each.
Players Players shottycore.profile Who is on and who was on last; each player’s sessions, names, punishments, notes, anticheat flags and party.
Punishments shottycore.history Every ban, mute, kick and warning, with search.
Watchlist shottycore.watchlist Players staff are keeping an eye on.
Chat logs shottycore.chatlog Chat and commands from every server.
Parties shottycore.profile The parties right now; shottycore.party.manage can break one up.
Staff Tasks shottycore.panel Work handed to staff members, with status and notes. shottycore.staff.manage hands tasks out.
Staff team shottycore.panel Everyone on staff by rank, with last seen and playtime; managers see more.
Applications shottycore.applications Staff applications from the website; shottycore.applications.form edits the form.
Shop Store shottycore.store Products, orders, refunds and the Stripe key.
Network Statistics shottycore.stats Players online, new players, busiest hours, countries, time per server, versions, moderation.
Map shottycore.map The live maps your game servers draw (BlueMap, squaremap …), behind the staff sign-in.
Servers shottycore.features Each server’s features and command groups switched on or off.
Website News shottycore.news Posts and changelog entries for your website.
Rules shottycore.rules The rules your website shows.
Voting shottycore.vote Vote sites, what a vote gives, and this month’s votes.
Admin Permissions shottycore.permissions Edit LuckPerms groups and players. Grants anything to anyone: admins only.
Reasons shottycore.reasons The preset reasons and lengths for bans, mutes, kicks, warnings and reports.
Chat filter shottycore.chatfilter Blocked and flagged words and regex rules.
Audit log shottycore.audit Everything staff did on the panel and with ShottyCore’s commands.
Email shottycore.admin The SMTP server the panel sends mail through, with a test button.
System shottycore.admin Modules, the database, and each game server’s link to the proxy.

A page whose module is off, or that needs LuckPerms when it isn’t there, is left out of the menu. The Account page (your name at the bottom of the menu) changes your password and authenticator, makes new recovery codes, lists your signed-in browsers, and holds your email address and your profile for the website.

On Admin → Email set the SMTP server, port, encryption, user, password, sender and a daily limit, and send a test. The password is stored sealed and never shown again. Nothing goes in config.yml.

With email set up:

  • Staff can add an address on their Account page (confirmed with a code). It gets a link for a forgotten password (which still asks for the authenticator) and a note on every sign-in, password change, lock and reset.
  • Staff with shottycore.notify.email choose what else to be emailed about: new reports, tickets, appeals, or a message flagged as serious. What happens within a minute arrives as one email, at most one every ten minutes.
  • Applicants are emailed as their staff application moves along (applications.email).

A ban screen points to <public-url>/appeal. The player enters their ban ID and name, writes an appeal and can come back to see the decision. Staff accept (which lifts the punishment) or deny on the Appeals page. At most web-panel.appeals.per-ip-per-hour (5) appeals come from one address an hour. This is the only page that works without signing in.

With public-api.enabled, the panel answers a few read-only addresses for your website, without a sign-in. Any site may read them; one address may ask public-api.per-minute (120) times a minute.

Address What it returns
GET /api/public/network Whether the network is up, how many are playing, and each server in public-api.servers with its label, its line, whether it is up and how many are on it.
GET /api/public/staff, /api/public/staff/{name} The staff team in rank order: rank, online or since when, what they wrote about themselves, a favourite server, and how many bans, kicks and mutes they gave. Staff in staff mode are left out.
GET /api/public/news, /api/public/news/{slug} Published posts (never drafts).
GET /api/public/rules The rules from the Rules page, or the built-in ones until those are saved.
GET /api/public/leaderboards Time played (all time and the last 30 days), friends, and longest on the network. Players under a running ban and anyone in leaderboards.hide are left out.
GET /api/public/vote The vote sites, what a vote gives, and this month’s top voters.
GET /api/public/apply, POST /api/public/apply The staff application form, and sending one (with a one-time link from /apply).
GET /api/public/store, POST /api/public/store/checkout The store’s products and starting a Stripe Checkout.

No ordinary player is ever named by the network and staff addresses. Set public-api.site-url to your website so the panel’s links to posts, rules and staff pages point there, and list your servers under public-api.servers:

public-api:
enabled: true
site-url: "https://www.example.com"
servers:
lobby:
label: "Lobby"
about: "Where everyone lands."
survival:
label: "Survival"
about: "Classic survival with friends."

/apply in game gives a player a link to your website’s form that only works for them, once, for applications.link-hours. The roles and questions start from applications in config.yml and can then be edited on Applications → Edit the form: short and long answers, pick one, pick any, yes or no, and questions asked only for a role or after a certain answer (visible-if). Staff read applications with the player’s playtime and punishments beside them, write notes for each other, and accept or decline. After a no, a player can apply again after applications.cooldown-days.

The store sells what you set up on the Store page, paid by card through Stripe Checkout. The plugin talks to Stripe’s API itself and gets a signed webhook at /api/public/stripe/webhook, made for you when the key is saved. A product is a list of steps, one per line:

Step What it does
group <name> [30d] Puts the buyer in a LuckPerms group, for good or for a number of days (days add up).
permission <node> [30d] Gives a permission, for good or for a number of days.
command <command> Runs a console command on the proxy, with {player} and {uuid}.
on <server> <command> Runs a console command on one game server, only while the buyer is on it with a free inventory slot. It waits until then and travels signed to that server’s companion, which runs it once.
on-refund <command> Runs when the order is refunded or disputed.

A refund (from the panel or in Stripe) takes back the groups and permissions, calls off steps still waiting and runs the on-refund steps; items already handed over stay. Prices are in one currency.

List each game server’s map under map.servers:

map:
allow-eval: false # true only for BlueMap, whose page needs it
servers:
survival: "http://10.0.0.5:8100"

The panel fetches the map’s pages for the signed-in staff member, so the map’s own port never needs to be open to the internet: bind it to a private address. Only GET is passed on, only to the listed addresses, and only for staff with shottycore.map. A map shows where every player is, which is why it sits behind the sign-in.