Docs · mod build 5.7
Linking to Reforgedmin
Optional. Connecting a server to your dashboard.
Linking is optional. The admin tools work exactly the same without it, and admins.json stays in charge of who's staff whether a server is linked or not.
Linking a server lets you see it on your Reforgedmin dashboard, and it's the channel the dashboard will use to talk to the server as more tools arrive there.
Linking a server
You need the Link to Reforgedmin permission (link_server), which only owners have to start with.
- In the panel, go to System Settings, then Reforgedmin, and press Get a Code. A short code like
K7QM-2XRAappears. - Sign in to reforgedmin.com with Steam, open the dashboard, and type the code into Link a server.
- Within a few seconds the page in game shows it's linked, and to whose account.
A code lasts 10 minutes. If it runs out, get a new one. Check Now asks the site straight away instead of waiting.
What the server sends
Once linked, the server checks in every 15 seconds with its name and how many players are on, so the dashboard can show it online. While you have its manage page open it checks in every 2 seconds instead, so whatever you do there happens within a couple of seconds, and it drops back to 15 within a minute of you leaving.
The one exception is the player list. Only while you have the server's manage page open, it also sends the names of the players on it right now, so you can see who's on. The site keeps just the current list and deletes it within a minute of you closing the page. Player Steam IDs, GUIDs, chat and your logs never leave your server.
The dashboard can't reach into a game server directly. Instead it leaves requests waiting, the server picks them up when it checks in, and sends the answers back the next time.
Managing a server from the website
Open a linked server from your dashboard to manage it without joining the game.
Everything runs as you. Each request carries the Steam ID of the account you're signed in with. The server looks that Steam ID up in its own admins.json and uses your permissions and rank from there, exactly like the in-game panel. So:
- Your Reforgedmin account needs Steam linked (Dashboard, then Settings). Signed in with Discord only, the tools stay greyed out.
- That Steam ID has to be on the server's staff list. If it isn't, the server refuses and says so.
- You can only act on players ranked below you, and only with permissions you have in game.
Anything done from the website goes in the same admin log and the same Discord Admin used an action event as the in-game panel, marked as coming from the website:
ozzie (via website) kicked Bob (camping spawn)
Online players
The Online players card lists everyone on the server with their in-game number. It appears within a few seconds of opening the page and keeps itself up to date while the page is open.
Kick asks for an optional reason. It goes in the admin log, the Discord event and the Connection list, and the player gets it as a message for a few seconds before they're removed. The kick screen itself always says "Kicked by Game Master": that's the game's own message and a mod can't change it. Kick needs the Kick permission (kick). If the player left, or someone else got their number in the meantime, nobody is kicked and the reply says why.
The result of every request shows under Connection, and the list there keeps them for 7 days.
Unlinking
Press Unlink on the Reforgedmin page in game, or remove the server from your dashboard. If you remove it on the dashboard, the server finds out the next time it checks in and forgets its key.
Where the key lives
$profile:HousoMods/Reforgedmin/Reforgedmin/link.json
The key in that file is what proves the server is yours. It's only ever read by the server and is never sent to any player. Don't share the file.