Complete documentation of the MajestatTopCore plugin (shown in the console as Majestat) for Rust servers running Oxide (uMod) or Carbon: installation, connecting to the rustserverlist.online network, modules, chat and RCON console commands, permissions, a full reference of the MajestatTopCore.json config and the data files. The plugin gives your server PvP and PvE statistics, XP, leaderboards in game and in the browser (/top, /fame), a web panel with a live map, a vote for next wipe's map and a /help panel with your rules — all in a single .cs file.
Author: Wo0t. Current version: 4.2.5 — download · changelog · API for plugins.
One plugin, one config. The whole system is one file,
MajestatTopCore.cs, and one flat config,oxide/config/MajestatTopCore.json. Statistics (Build/Gather/Loot), the web panel, the map, the vote, the info panel and the global network are internal modules of a single class, switched on withEnable Panel,WEB - Enable Module,VOTE - Enable ModuleandINFO - Enable Module. Version-by-version changes: Changelog.Display name vs. technical name. In the console the plugin now introduces itself as
Majestat(log prefix[Majestat], "Loaded plugin Majestat v4.0.0"). The technical class name staysMajestatTopCore, so the config file is stilloxide/config/MajestatTopCore.jsonand all internal references keep working.The startup message is a single box: name + version + database mode + number of profiles, module state from the config (
INFO,WEBwith API mode and port,VOTE) and log level. After the first connection to the global network you get the lineMajestat ready [OK][MASTER],[OK][MASTER RATES]or[OK][LOCAL]— with integration on, the plugin adds the reason (in LOCAL: why the rates come from the config, in MASTER RATES: why player stats are not sent to the network, e.g. no token). All console messages are in English. Network messages ([Net] …,[Update] …) appear a moment later.
Architecture#
Everything runs in one class, MajestatTopCore (display name: Majestat). Inside are modules that talk to each other through direct method calls, and to other plugins through public API_* hooks (see API).
┌────────────────────────────── Majestat (MajestatTopCore.cs) ──────────────────────────────┐
Rust hooks ───► │ CORE: player profiles, XP, XP thresholds, JSON/SQLite/MySQL database, /top, pop-ups │
(kills, gather, │ ▲ │
loot, build) │ │ API_AddStat / API_RegisterTab │
│ STATS: GATHER / LOOT / BUILD tabs │
│ │
│ WEB (HttpListener :28020) ── MAP (image + positions) ── VOTE (RustMaps) ── INFO (/help) │
│ │
│ NET: connection to the rustserverlist.online global network, verification, /global │ ──► network
└───────────────────────────────────────────────────────────────────────────────────────────┘
Rules worth knowing:
- Stats vs Fame. Every player has two sets of counters:
Stats(season, cleared by a reset) andFameStats(all time). - Two XP modes — never mixed. MASTER (verified server, rates from the global network) or LOCAL (rates from the config). Details: Full configuration → "XP source".
- The local counter always runs. Every event is counted locally; in MASTER mode statistics also go to the global network. The /top table reads local data.
- Nothing is lost without a connection. When the global network is unavailable, statistics wait locally and are sent once the connection is back.
Installing on Oxide (uMod) and Carbon#
The plugin works the same way on both frameworks — only paths and the command prefix differ:
| Oxide (uMod) | Carbon | |
|---|---|---|
| Plugin file | oxide/plugins/MajestatTopCore.cs |
carbon/plugins/MajestatTopCore.cs |
| Config | oxide/config/MajestatTopCore.json |
carbon/configs/MajestatTopCore.json |
| Data | oxide/data/ |
carbon/data/ |
| Reload | oxide.reload MajestatTopCore |
c.reload MajestatTopCore |
| Permissions | oxide.grant user <steamid> <perm> |
c.grant user <steamid> <perm> |
The rest of this documentation uses Oxide paths — on Carbon replace oxide/config with carbon/configs and oxide/data with carbon/data.
- Upload
MajestatTopCore.cstooxide/plugins/(Carbon:carbon/plugins/). Do not rename the file — it must match the class name. Delete old files if they are left over from earlier versions:MajestatStats.cs,MajestatTopBuild.cs,MajestatTopGather.cs,MajestatTopLoot.cs,MajestatTopWeb.cs,MajestatTopMap.cs,MajestatTopVote.cs,MajestatTopInfo.cs,MajestatTopNet.cs— otherwise tabs and commands get duplicated. - On first start
oxide/config/MajestatTopCore.jsonis created. Fill in at least:NET - Token(global network; since 4.2.5 you can get the token straight from the game with/verify, and a server verified before gets it back by itself after a reinstall),VOTE - RustMaps API Key(map vote) and your MySQL details (ifDatabase Mode = MYSQL). LeaveNET - Server IDempty — since 4.2.5 the plugin asks the network whether the server is listed and writes the ID itself. Where to get the ID and token: Connecting to the Majestat network. - Reload the plugin (
oxide.reload MajestatTopCore/c.reload MajestatTopCore) or, for the config alone,mtopcore.reloadcfg.
External dependencies:
| Needed for | What |
|---|---|
| Map images in the vote (CUI) | the ImageLibrary plugin |
| Drawing maps for the vote | a RustMaps API key (VOTE - RustMaps API Key) |
| Web panel | an open TCP port WEB - HTTP Port (default 28020) |
| Verification in the network | NET - Token + NET - Master Integration = true |
| MySQL mode | a MySQL server |
| Clan / friends chat, FF | optionally the Clans and Friends plugins (detected automatically) |
Connecting to the Majestat network — server ID and token#
First check whether your server is already listed. Public Rust servers are discovered automatically (Steam master list, A2S queries), so your server most likely already has an entry on rustserverlist.online. Plugin data has to reach the existing entry — otherwise the same server would show up twice: once as an A2S entry and once as a plugin entry.
Since 4.2.5 the plugin does this by itself. With an empty
NET - Server IDand no ID in data, on the first start the plugin asks the network whether the server is already listed (IP and game port, then query port, then the same IP and name). If it is, the plugin takes over the entry's ID. If not, it creates a new ID and registers the server. It writes the ID toNET - Server IDby itself. Console:[Net] This server is already on the Majestat list as '<id>' - taking over that IDor[Net] Server ID: <id> - new (not on the Majestat list yet). Without a connection the plugin keeps asking and does not create an ID in advance. On a Master older than 2.7.4 the plugin creates its ID by itself, as before 4.2.5.You only need the steps below to set the ID by hand or to claim the server for your Steam account.
The server is already listed (most common)#
-
Find your server with the search on the server list and open its profile.
-
Claim it: the "Claim this server" button on the profile (code in the server name, code in the description, or an RCON login). Once claimed, the server is on your Steam account.
-
Copy the server ID: profile → Server settings → the "Server ID (NET - Server ID)" field with the Copy button. (It is also the
id=value in the profile address.) -
In
oxide/config/MajestatTopCore.json(Carbon:carbon/configs/MajestatTopCore.json) set:"NET - Master Integration": true, "NET - Server ID (empty = auto)": "<ID copied from the profile>", "NET - Admin / Owner SteamID64": "<your SteamID64>", -
Reload the plugin (
oxide.reload MajestatTopCore/c.reload MajestatTopCore). The console shows[Net] Server ID set from config: …and shortly afterHeartbeat [OK]. From now on the same entry receives plugin data — a chart sample every minute, online players, chat, joins and leaves.
Forgot the ID? Nothing breaks. If the plugin reports with a new random ID from the same IP:port as an existing entry, the network does not create a second entry — it sends a console warning instead:
[Net] DUPLICATE: a server with this IP:port already exists in the network as ID '<id>'. To merge the entries, set "NET - Server ID (empty = auto)": "<id>" in the config and reload the plugin.Put that ID in the config and reload the plugin. Since 4.2.5 a plugin with an automatic ID does this by itself when the entry has no token. It does not change an ID set by hand.
The server is not listed (private / new)#
Leave NET - Server ID empty and put your SteamID64 in NET - Admin / Owner SteamID64. The plugin registers the server with its first heartbeat and assigns it to your account. Since 4.2.5 it also writes the ID to NET - Server ID by itself, so it survives deleting the data folder.
Where to get the token (NET - Token)#
The token gives verification: the green ✓ badge, MASTER mode (XP rates from the network) and player stats in the global ranking. Without a token the plugin still works and reports the server (chart, players, chat). With NET - Master Integration = true it then uses the network's XP rates (MASTER RATES mode, since 4.2.0) but does not send player stats; with false — LOCAL mode with the config's rates.
Easiest from the game (since 4.2.5): the server admin types /verify (or mjnet.verify in the console). The plugin checks that the server meets the Majestat standard and sends a request. After approval (automatic or by a network admin) the token saves itself to NET - Token — nothing to copy. A request from an address other than the server IP is always approved by hand by a network admin. Check the state with mjnet.verify status. A server that meets the standard but has no token or request gets a reminder every NET - Verification reminder (minutes, 0 = off) minutes.
From the website:
- First link the server to the right ID (steps above) — the token is bound to the entry's ID. With a different ID the network rejects it (
401 bad token). - Go to My account → next to the server click "Request verification".
- Once the admins decide, the token arrives in Messages (My account).
- Paste it into
NET - Token, make sureNET - Master Integrationistrue, and reload the plugin. Console:[Net] Verification: VERIFIEDandMode: MASTER.
Reinstall (since 4.2.5). A server verified before gets its token back by itself when the plugin with no ID and token connects from the server IP, the port matches, no other servers share that IP and the server meets the standard. Otherwise a request goes to the network admin and the token is saved automatically after approval.
Verification block (since 4.2.1). A server with
Enable XP = false,Enable PvP Stats = falseor with a TOP column hidden that the network requires (a list set in the network panel and sent asrequiredColumns) cannot be verified — even with a valid token. The plugin reports it in the heartbeat (verification: "blocked"+ reasons), and the network website shows the reason in Edit and next to the verification request (e.g. "XP is disabled on the server", "The server hides a required column: PvP kills"). Console:[Net] Verification blocked by local settings: …. After changing the config just runmtopcore.reloadcfg.
Already have two entries for the same server?#
Set NET - Server ID to the ID of the entry you want to keep (usually the claimed one, with history and comments), reload the plugin, and delete the other entry: its Server settings → Danger zone → Delete server.
Plugin modules#
Modules are parts of one plugin. They have no separate files or configs.
| Module | What it does | Config switch |
|---|---|---|
| CORE | Player profiles, XP and XP thresholds, database, kill pop-ups, friendly fire, API | always on |
| PANEL | In-game leaderboard window (/top, /fame, /gather…) and XP INFO |
Enable Panel |
| STATS | The GATHER, LOOT, BUILD, SHIPS, FARMING, FISHING, RECYCLING, GAMBLING tabs and their counters | always on |
| WEB | Web panel: leaderboards, profiles, chat, admin console, XP INFO, Game Info, JSON export | WEB - Enable Module |
| MAP | Live map in the web panel (rendermap image, players, events, shops) |
together with WEB |
| VOTE | Vote for next wipe's map (in game and on the web) | VOTE - Enable Module |
| INFO | /help panel / rules and a periodic chat broadcast |
INFO - Enable Module |
| NET | Global network: server status, statistics for the global ranking, /global, verification |
always on (runs in LOCAL without a token) |
| HUD | Panel on the screen edge: world events, players, map grid square, time, player time, XP, network achievements | HUD - Enabled |
Leaderboard tabs (order, PL / EN names): TOP (0) → ZBIERANIE / GATHER (10) → ŁUPY / LOOT (15) → BUDOWA / BUILD (20) → STATKI / SHIPS (25) → FARMING (27) → ŁOWIENIE / FISHING (30) → RECYKLING / RECYCLING (35) → HAZARD / GAMBLING (40) → SŁAWA / FAME (always last). Button width adapts to the number of tabs. The same tabs are in the web panel and on the player profile.
Columns:
- PvP (TOP): XP (sum of all in-game XP from every enabled source), PVP XP (since 4.2.1 — XP for killing players plus PvP headshots and distance), PvP kills, PvP deaths, PvE deaths, Heli, Bradley, Scientists, Zombies, Animals, Friendly fire, playtime (every column has a
Show … Columnswitch). WithEnable XP = falseXP, PVP XP and Friendly fire disappear; withEnable PvP Stats = false— PVP XP, PvP kills and PvP deaths Since 4.2.5 scientists killed on ghost ship wrecks, boats and Deep Sea islands (outside the land map or over a seabed deeper than 25 m) have their own network typeKill.Scientist.opensea(heavy:openseaheavy) — "Open Sea" 🌊 on the website. - GATHER: TOTAL, WOOD, STONE, METAL, HQM, SULFUR, SCRAP, FOOD, DIESEL. Since 4.2.0 FOOD = any item in the game's Food category — from gathering (wild plants, crops, coconuts, meat from corpses) and from world crates (cans, bars…), without seeds, clones and hemp. Every kind is sent to the network separately; on the network player profile food from crates is shown under Loot and food from the ground under Farming.
- LOOT: TOTAL, ELITE, MILITARY, HELI/APC, LOCKED, AIRDROP, UNDERWATER, FOOD, VEHICLE, CRATES, BARRELS, KEYCARDS (since 4.2.2 — keycards used, all colours together; not included in TOTAL. A successful green, blue or red keycard swipe at a card reader, the same reader once per 10 min. The player profile in the network splits them by colour)
- BUILD: TOTAL, WALLS, FOUNDATIONS, FLOORS, ROOF, DOORS, TURRETS, TRAPS, ELECTRICAL, WATER, INDUSTRIAL
- SHIPS (since 4.1.0): SHIPS (launched), PARTS (sum of parts), HULL, DECK, WALLS, STAIRS, DOORS, SAILS, ENGINES, STEERING, CANNONS, ANCHORS, OTHER. A ship counts once, when launched; ship parts (doors and cannons too) do not count as BUILD.
- FARMING (since 4.2.0): TOTAL (everything except milking and shearing), CLOTH (including from hemp), ANIMAL FAT, LEATHER, BONE (from animal, player and NPC corpses), MUSHROOMS, PUMPKINS, CORN, WHEAT, POTATOES, BERRIES (all colors together), MILKED, SHEARED. Milking and shearing are always 0 for now — the game has no hook for them yet. The amount that reached the inventory counts (after server multipliers); seeds and clones do not.
- FISHING (since 4.1.0): FISH, CASTS, CATCH % (fish / casts × 100), CATFISH, ORANGE ROUGHY, SALMON, SHARK, TROUT, PERCH, ANCHOVY, HERRING, SARDINE, JUNK. Only fish caught with a rod count (fish traps do not).
- RECYCLING (since 4.1.0): RECYCLED (items), CYCLES, MONUMENT, SAFE ZONE, SCRAP, HQM, METAL, CLOTH, CARS (since 4.2.2 — vehicles destroyed in the junkyard car shredder; they count for the magnet crane operator or whoever left the crane at most 2 min earlier. Materials dropped by the shredder — scrap, metal, HQM — count for them as recycling; driving the crane counts as the "Magnet Crane" vehicle). Since 4.1.1 the recycler's position decides about safe zone (game safe zones plus Outpost, Bandit Camp and fishing villages).
- GAMBLING (since 4.1.0): PROFIT (total, can be negative), GAMES, and for the Big Wheel, slot machines and blackjack: PROFIT / WAGERED / PAYOUT. Profit = payout − wagered. Poker is counted and shown on the network player profile.
Fish species outside the list and other recycler outputs are counted and sent to the network, but have no column in the panel.
Chat commands (players and admins)#
Leaderboards and statistics (Core)#
| Command | Description |
|---|---|
/top |
Opens the leaderboard panel (PvP tab) |
/gather / /topgather |
Leaderboard — GATHER tab |
/loot / /toploot |
Leaderboard — LOOT tab |
/build / /topbuild |
Leaderboard — BUILD tab |
/fame |
Fame leaderboard (all time, PvP) |
/famepvp |
Fame on the PvP tab |
/famegather |
Fame on the GATHER tab |
/fameloot |
Fame on the LOOT tab |
/famebuild |
Fame on the BUILD tab |
/ships / /statki |
Leaderboard — SHIPS tab (since 4.1.0) |
/farming / /farma |
Leaderboard — FARMING tab (since 4.2.0) |
/fishing / /ryby |
Leaderboard — FISHING tab (since 4.1.0) |
/recycle / /recykling |
Leaderboard — RECYCLING tab (since 4.1.0) |
/gambling / /hazard |
Leaderboard — GAMBLING tab (since 4.1.0) |
/stats [nick] |
XP summary in chat. No argument = your own; with a nick = requires admin |
/xpinfo |
Table of how much XP each activity gives. (4.2.2) Opens the XP TABLE panel (the same as the button in /top); chat text only with Enable Panel = false. (4.2.1) With Enable XP = false it answers "XP is disabled on this server." |
/mtopreset [confirm] |
Reset of season statistics (admin). Without confirm → a warning and 15 s to confirm |
/crateinfo |
(admin) Info about the crate/barrel you are looking at (up to 10 m): prefab, path, type, height, Loot.* category. |
/topreset |
Alias of /mtopreset (compatibility with 2.9.2) |
/fame*works only whenEnable Fame Leaderboard = true.
HUD panel#
| Command | Description |
|---|---|
/hud |
Turns the HUD panel on / off for a player (stored in data/MajestatHud.json) |
/ach |
Expands the 3 closest network achievements under the panel (like the ▼ button); without data it says why |
A fixed panel on the screen edge, top-left by default (settings: HUD — on-screen panel). Rows from the top:
| Row | Content |
|---|---|
| events | Icons and captions HELI (patrol heli), CH47, APC (Bradley), VENDOR (travelling vendor), CARGO, DROP (supply plane or a supply crate on the map). No background — while an event is on, the icon and caption light up: HELI and APC red, CH47 and CARGO yellow, VENDOR and DROP green. An attacked CH47 stays red until it leaves, an attacked vendor for 90 s after the last hit |
| players | Online N Sleeping M, the player's map grid square (e.g. H9, like the in-game map grid; ~ on the open sea) and in-game time HH:mm |
| player | Time — the player's all-time time on this server (Fame) and on the right their season XP as in TOP (1 243 XP); no XP with Enable XP = false |
| achievements | ▼ ACHIEVEMENTS 5/40 ▼ (earned / all) — a click or /ach expands the 3 closest achievements with artwork, progress and a bar; the list hides after HUD - Achievements list seconds |
| footer | Verified server: MAJESTAT NETWORK • rustserverlist.online; unverified: the server's website (NET - Web panel URL, then server.url, then the plugin's web panel address) |
- The top strip of the panel shows the verification colour (green / orange / blue), like the badge in
/top. - Achievement banner: when a player earns an achievement, an "ACHIEVEMENT UNLOCKED!" banner slides out under the panel: header, large artwork (the same as on the network website), name and requirement, with a sound. It hides after
HUD - Achievement banner seconds, several at once show one by one. An achievement earned while the player was offline shows after they join. The first fetch for a player only stores the state, with no banners for old achievements. - Live achievements: the plugin takes the player's progress from the network and adds what they do on the server at every HUD refresh. The banner pops right after the threshold is crossed and the network confirms the achievement shortly after — there is no second banner. Network data can only raise the progress. Rankings and network-computed XP wait for the network.
- Achievements work only on a verified server with
NET - Master Integration = trueand achievements enabled in the network. Without verification there is no button or banners, and/achreplies "Server not verified — no global stats or Majestat network achievements." - Images go over HTTPS only — the Rust client blocks http ("Insecure connection not allowed"). An
http://icons URL gives captions only and a console warning. Without achievement artwork the plugin draws an in-game item icon or a star. - Console diagnostics:
mtopcore.hud <steamid|nick> [refresh].
INFO panel / server rules (Info)#
| Command | Description |
|---|---|
/help /info /rules /regulamin |
Opens the info panel (the command list is configurable — Commands field) |
/topinfo reload |
Reloads the Info configuration without reloading the plugin (admin) |
/broadcast <text> |
Manual broadcast-style announcement in chat (admin) |
Map vote (Vote)#
| Command | Description |
|---|---|
/vote /glosuj |
Opens the vote panel for the next map (commands are configurable — Chat Commands) |
/voteadmin status |
Vote state: session, time left, maps and vote counts (admin) |
/voteadmin open |
Opens a vote manually when none is running (admin) |
/voteadmin close |
Closes the vote and picks the winner (admin) |
/voteadmin restart |
Aborts the current vote (no winner) and starts over: new maps, zero votes (admin) |
/voteadmin reroll |
Draws a new set of maps in the running vote (admin) |
The same actions are available from the server console / RCON as mtopcore.vote <action> — see Console / RCON commands → Vote.
Global network (Net)#
| Command | Description |
|---|---|
/global |
Cross-server global ranking panel (only when the server is verified with a token) |
/verify |
(4.2.5, admin) Verification request in the Majestat network. Checks the conditions and sends the request; after approval the token saves itself to NET - Token |
/buildinfo |
BUILD classification info — which category a building part goes to; since 4.1.0 also the part's parent and the ship part (ship.*, ship ID, whether the ship is already counted) (admin, since 4.0.4) |
Console / RCON commands#
Core#
| Command | Description |
|---|---|
mtopcore.reloadcfg |
Reloads the Core config. Server console / RCON only (blocked for players) |
mtopcore.reset <steamid|nick> |
Resets season statistics of one player (Fame stays). Admin/console |
mtopcore.resetall |
Resets season statistics of all players, immediately, without confirmation (Fame stays) |
mtopcore.mapdiag |
Entity/map diagnostics (Bradley, Heli, CH47, Cargo, NPCs, animals) — helps with kill classification. Admin |
mtopcore.xpdiag |
Effective XP rates and their source (MASTER / LOCAL): distance, headshot, playtime, notification mode. Shows what disables distance XP. Admin |
mtopcore.hold |
Statistics waiting to be sent to the global network (e.g. new counters the network does not accept yet). Admin |
mtopcore.npclast |
Last killed NPC: prefab, name, assigned monument and distance from its bounds — for reports about wrong scientist types. Admin (since 4.0.4) |
mtopcore.netdiag |
Network connection diagnostics: Master address, last heartbeat, response code and time (e.g. HTTP 200 in 85 ms). Admin (since 4.0.4) |
mtopcore.worldlast [N] |
Last N (default 15, max 40) ship, fishing, recycling and gambling events: who, what, which counter, ship ID, recycler location (safe zone / monument / base). Ends with the number of ships counted this wipe. Admin (since 4.1.0) |
mtopcore.hud <player> [refresh] |
(4.2.3) HUD and achievement state of a player: events, API address, last HTTP code and error, earned / all, next with artwork URLs; refresh fetches again. Admin |
Core — internal UI commands (called by panel buttons)#
| Command | Description |
|---|---|
majestattopcore.ui <tab> <fame0/1> <fameTab> <xpinfo0/1> |
Opens the panel on a specific tab |
majestattopcore.close |
Closes the leaderboard panel |
majestattopcore.openinfo <tab> |
Opens the embedded Info panel |
majestattopcore.openvote |
Opens the vote panel |
majestattopcore.infotab <tab> |
Switches the tab in the Info panel |
majestattopcore.closeinfo |
Closes the Info panel and returns to the leaderboard |
Info#
| Command | Description |
|---|---|
majestattopinfo.open <tab> |
Opens the Info panel |
majestattopinfo.tab <tab> |
Switches the Info tab |
majestattopinfo.dismiss <tab> |
Marks the panel as "don't show on join" for the player |
majestattopinfo.undismiss <tab> |
Undoes the above |
majestattopinfo.openurl <url> |
(4.2.2) Window with the link in a text field (select, Ctrl+C) + the link in the F1 console and chat |
majestattopinfo.closelink |
(4.2.2) Closes the link window |
majestattopinfo.close |
Closes the Info panel |
Vote#
Managing the vote from the console / RCON (the admin does not have to join the server). From a player's console (F1) — admin or majestattopcore.voteadmin only.
| Command | Description |
|---|---|
mtopcore.vote status |
Vote state: session ID, OPEN / CLOSED / ABORTED, time left, map list (size / seed / votes, winner) |
mtopcore.vote open |
Opens a vote (when none is running). It closes on the wipe schedule; if that time has already passed — in 5 minutes |
mtopcore.vote close |
Ends the vote now and announces the winner (winner file / command / convars according to the config) |
mtopcore.vote restart |
Aborts the current vote without a winner and opens a new one: new maps from RustMaps, votes cleared, same closing time |
mtopcore.vote reroll |
Draws new maps in the running vote (votes cleared) |
Example over RCON: mtopcore.vote restart. The reply goes back to the RCON console and into the server log. The automatic schedule will not reopen a vote that was closed manually for the same wipe.
Internal UI commands (called by panel buttons):
| Command | Description |
|---|---|
majestattopvote.open |
Opens the vote panel |
majestattopvote.vote <idx> |
Casts a vote for the map with index idx |
majestattopvote.close |
Closes the vote panel |
majestattopvote.backtotop |
Closes the panel and returns to the leaderboard (majestattopcore.ui pvp) |
Net#
| Command | Description |
|---|---|
mjnet.flush |
Forces an immediate sync with the global network. Admin/console |
mjnet.verify [status] |
(4.2.5) Verification request from the console (like /verify); status — token, whether the server meets the standard, request state, reason. Admin/console |
mtglobal.close |
Closes the global panel (internal) |
The map and the web panel have no chat/console commands of their own — they work over HTTP.
Permissions (Oxide / Carbon)#
| Permission | Grants access to |
|---|---|
majestattopcore.admin |
Statistics reset (/mtopreset, mtopcore.reset*), /stats <nick>, /verify (4.2.5), admin in the web panel |
majestattopcore.info |
Access to the Info panel when INFO - Require permission = true |
majestattopcore.infoadmin |
/topinfo reload, /broadcast |
majestattopcore.voteadmin |
/voteadmin |
Fix in 4.0.0 RC1: the Info and Vote permissions use the
majestattopcore.prefix (previouslymajestattopinfo.use,majestattopinfo.admin,majestattopvote.admin). Oxide requires a permission to start with the plugin name, so after the merge the old names were not registered (console:Missing plugin name prefix 'majestattopcore') and did not work. Permissions granted under the old names have to be granted again under the new ones.
Granting, e.g.:
oxide.grant user <steamid> majestattopcore.admin
oxide.grant group admin majestattopcore.admin
On Carbon: c.grant user <steamid> majestattopcore.admin (Carbon also accepts the oxide.grant commands).
The server admin flag (IsAdmin) also bypasses the restrictions.
Full configuration#
Build 4.0.0 — one plugin, one config. After the full merge the whole system is one file,
MajestatTopCore.cs, and one config,oxide/config/MajestatTopCore.json. There are no separateMajestatTopWeb.json,MajestatTopVote.json,MajestatTopInfo.jsonorMajestatTopNet.jsonfiles any more — all keys live in one flat object.JSON has no sections or separators, so you can tell which module a key belongs to by the prefix in its name: no prefix = CORE,
INFO -,WEB -,VOTE -,NET -. The order of keys in the generated file is fixed: database →Language (pl/en)→ NET (the token and Master integration are at the top because they decide the XP source) → the rest of CORE → WEB → VOTE → INFO (always last, because it contains long tabs and the broadcast). The example below is generated automatically from the code, so it matches 1:1 what the plugin writes.Migrating from the old files: on the first start of 4.0.0 the plugin creates a new
MajestatTopCore.jsonwith default values. Move your settings over from the old configs (especially MySQL details,VOTE - RustMaps API Key,NET - Token, theINFO - Tabscontents). The old config files can be deleted.
MajestatTopCore.json (full, in generation order)#
The default texts in the example (vote messages, Info tabs, broadcast) are in Polish — replace them with your own; set Language (pl/en) to "en" for an English web panel and console messages.
{
"Database Mode (JSON, SQLITE, MYSQL)": "JSON",
"MySQL Host": "localhost",
"MySQL Port": 3306,
"MySQL Database Name": "rust_stats",
"MySQL User": "root",
"MySQL Password": "password",
"Language (pl/en)": "pl",
"Language - follow player's game language": false,
"NET - Master Integration": true,
"NET - Token": "",
"NET - Server ID (empty = auto)": "",
"NET - Admin / Owner SteamID64": "",
"NET - Verified notice (both/broadcast/banner/off)": "both",
"NET - Icon SteamID (0 = none)": 76561199874842386,
"NET - Server type": "modded",
"NET - Wipe schedule": "monthly",
"NET - Web panel port": 28020,
"NET - Web panel URL (empty = auto)": "",
"NET - Update channel (stable/dev)": "stable",
"NET - Verification reminder (minutes, 0 = off)": 30,
"Enable Panel": true,
"Enable Fame Leaderboard (/fame)": true,
"Reset Season Stats On Wipe": false,
"Enable XP": true,
"Enable PvP Stats": true,
"Leaderboard Sorting Mode (XP, PVP_KILLS, PLAY_TIME)": "XP",
"Fame Leaderboard Sorting Mode (XP, PVP_KILLS, PLAY_TIME)": "XP",
"Show Total XP Column": true,
"Show PvP XP Column": true,
"Show PvP Kills Column": true,
"Show PvP Deaths Column": true,
"Show PvE Deaths Column": true,
"Show Heli Kills Column": true,
"Show Bradley Kills Column": true,
"Show Scientist Kills Column": true,
"Show Zombie Kills Column": true,
"Show Animal Kills Column": true,
"Show Friendly Fire Column": true,
"Show Play Time Column": true,
"Points Per PvP Kill": 5,
"Points Per Zombie Kill": 2,
"Points Per Animal Kill": 1,
"Points Per Bradley Kill": 20,
"Points Per Heli Kill": 20,
"Points Per Scientist Kill": 3,
"Points Per Headshot (extra, PvP + Scientist/Zombie)": 2,
"Play Time - Minutes per award": 30,
"Play Time - XP per award": 1.0,
"Points Per Distance Step (extra per step; 0 = off)": 1,
"Distance Step (m) for distance XP + pop-up": 100,
"Show Distance Line In Kill Pop-up": true,
"Friendly Fire - PvP XP Penalty (0 = off)": 0,
"Friendly Fire - PvE XP Penalty (0 = off)": 0,
"Friendly Fire - Friendly NPC prefabs (substring match)": [
"waterwell_shopkeeper",
"shopkeeper",
"bandit_shopkeeper",
"missionprovider"
],
"Gather.Wood": 1.0,
"Gather.Stone": 1.0,
"Gather.Metal": 1.0,
"Gather.HQM": 1.0,
"Gather.Sulfur": 1.0,
"Gather.Food": 1.0,
"Gather.Scrap": 1.0,
"Gather.Diesel": 1.0,
"Loot.EliteCrate": 1.0,
"Loot.MilitaryCrate": 1.0,
"Loot.LockedCrate": 1.0,
"Loot.HackableCrate": 1.0,
"Loot.Airdrop": 1.0,
"Loot.UnderwaterCrate": 1.0,
"Loot.FoodCrate": 1.0,
"Loot.VehicleCrate": 1.0,
"Loot.NormalCrate": 1.0,
"Loot.Barrel": 1.0,
"Loot.Total": 1.0,
"Build.Walls": 1.0,
"Build.Foundation": 1.0,
"Build.Floors": 1.0,
"Build.Roof": 1.0,
"Build.Doors": 1.0,
"Build.Turrets": 1.0,
"Build.Traps": 1.0,
"Build.Electrical": 1.0,
"Build.Water": 1.0,
"Build.Industrial": 1.0,
"Build.Total": 1.0,
"Ship.Ships": 1.0,
"Ship.Hull": 1.0,
"Ship.Floor": 1.0,
"Ship.Wall": 1.0,
"Ship.Stairs": 1.0,
"Ship.Door": 1.0,
"Ship.Sail": 1.0,
"Ship.Engine": 1.0,
"Ship.Steering": 1.0,
"Ship.Cannon": 1.0,
"Ship.Anchor": 1.0,
"Ship.Other": 1.0,
"Ship.Total": 1.0,
"Fish.Casts": 1.0,
"Fish.Catfish": 1.0,
"Fish.OrangeRoughy": 1.0,
"Fish.Salmon": 1.0,
"Fish.SmallShark": 1.0,
"Fish.SmallTrout": 1.0,
"Fish.YellowPerch": 1.0,
"Fish.Anchovy": 1.0,
"Fish.Herring": 1.0,
"Fish.Sardine": 1.0,
"Fish.Junk": 1.0,
"Fish.Total": 1.0,
"Recycle.Cycles": 1.0,
"Recycle.Items": 1.0,
"Recycle.Scrap": 1.0,
"Recycle.HQM": 1.0,
"Recycle.Metal": 1.0,
"Recycle.Cloth": 1.0,
"Recycle.ShredCars": 1.0,
"Card.Used.Green": 1.0,
"Card.Used.Blue": 1.0,
"Card.Used.Red": 1.0,
"Gamble.Rounds.Total": 1.0,
"Gamble.BigWheel.Rounds": 1.0,
"Gamble.Slots.Rounds": 1.0,
"Gamble.Blackjack.Rounds": 1.0,
"Gamble.Wins.Total": 1.0,
"Gamble.Wagered.Total": 0.0,
"Farm.Cloth": 1.0,
"Farm.AnimalFat": 1.0,
"Farm.Leather": 1.0,
"Farm.Bone": 1.0,
"Farm.Mushroom": 1.0,
"Farm.Pumpkin": 1.0,
"Farm.Corn": 1.0,
"Farm.Wheat": 1.0,
"Farm.Potato": 1.0,
"Farm.Berry": 1.0,
"Farm.Milk": 1.0,
"Farm.Wool": 1.0,
"Farm.Total": 1.0,
"XP - Amount per award (units per XP award)": {
"Gather.Wood": 10000.0,
"Gather.Stone": 10000.0,
"Gather.Metal": 10000.0,
"Gather.HQM": 200.0,
"Gather.Sulfur": 5000.0,
"Gather.Food": 100.0,
"Gather.Scrap": 2000.0,
"Gather.Diesel": 30.0,
"Loot.EliteCrate": 50.0,
"Loot.MilitaryCrate": 50.0,
"Loot.LockedCrate": 30.0,
"Loot.HackableCrate": 30.0,
"Loot.Airdrop": 20.0,
"Loot.UnderwaterCrate": 50.0,
"Loot.FoodCrate": 100.0,
"Loot.VehicleCrate": 50.0,
"Loot.NormalCrate": 100.0,
"Loot.Barrel": 100.0,
"Loot.Total": 100.0,
"Build.Walls": 100.0,
"Build.Foundation": 100.0,
"Build.Floors": 100.0,
"Build.Roof": 100.0,
"Build.Doors": 50.0,
"Build.Turrets": 20.0,
"Build.Traps": 20.0,
"Build.Electrical": 100.0,
"Build.Water": 100.0,
"Build.Industrial": 100.0,
"Build.Total": 100.0,
"Ship.Ships": 1.0,
"Ship.Hull": 50.0,
"Ship.Floor": 50.0,
"Ship.Wall": 50.0,
"Ship.Stairs": 10.0,
"Ship.Door": 10.0,
"Ship.Sail": 10.0,
"Ship.Engine": 5.0,
"Ship.Steering": 5.0,
"Ship.Cannon": 10.0,
"Ship.Anchor": 5.0,
"Ship.Other": 50.0,
"Ship.Total": 100.0,
"Fish.Casts": 100.0,
"Fish.Catfish": 10.0,
"Fish.OrangeRoughy": 10.0,
"Fish.Salmon": 10.0,
"Fish.SmallShark": 10.0,
"Fish.SmallTrout": 10.0,
"Fish.YellowPerch": 10.0,
"Fish.Anchovy": 20.0,
"Fish.Herring": 20.0,
"Fish.Sardine": 20.0,
"Fish.Junk": 20.0,
"Fish.Total": 50.0,
"Recycle.Cycles": 50.0,
"Recycle.Items": 500.0,
"Recycle.Scrap": 1000.0,
"Recycle.HQM": 100.0,
"Recycle.Metal": 5000.0,
"Recycle.Cloth": 1000.0,
"Gamble.Rounds.Total": 100.0,
"Gamble.BigWheel.Rounds": 50.0,
"Gamble.Slots.Rounds": 50.0,
"Gamble.Blackjack.Rounds": 50.0,
"Gamble.Wins.Total": 20.0,
"Gamble.Wagered.Total": 1000.0,
"Farm.Cloth": 1000.0,
"Farm.AnimalFat": 500.0,
"Farm.Leather": 500.0,
"Farm.Bone": 1000.0,
"Farm.Mushroom": 20.0,
"Farm.Pumpkin": 20.0,
"Farm.Corn": 20.0,
"Farm.Wheat": 20.0,
"Farm.Potato": 20.0,
"Farm.Berry": 50.0,
"Farm.Milk": 10.0,
"Farm.Wool": 10.0,
"Farm.Total": 1000.0
},
"XP - Award notice (banner/chat/off)": "banner",
"XP - Progress bar": true,
"XP - Progress bar position Y": 0.115,
"HUD - Enabled": true,
"HUD - Default on for new players": true,
"HUD - Position (top-right, top-left, middle-right, middle-left)": "top-left",
"HUD - Offset X (pixels from the side edge)": 8.0,
"HUD - Offset Y (pixels down from the top / middle)": 10.0,
"HUD - Show world events": true,
"HUD - Event icons URL (https, empty = network site, off = text)": "",
"HUD - Refresh interval (seconds)": 3.0,
"HUD - Achievements": true,
"HUD - Achievement banner seconds": 4.0,
"HUD - Achievements list seconds": 4.0,
"HUD - Achievements refresh (seconds)": 180.0,
"Ship - Launched ship prefab keywords (empty = auto)": [],
"Auto-Save Interval (seconds)": 60.0,
"Unknown NPC fallback category (animal, scientist, zombie, none)": "animal",
"Log Level (all, system, alert, none)": "system",
"Leaderboard Cache TTL (seconds)": 30.0,
"Max rows per leaderboard tab": 10,
"Number Format (none, K, M, KM)": "M",
"Number Format Decimal Places": 1,
"Show pop-up kills": true,
"Type pop-up kills (pvp, pve, all)": "all",
"Kill pop-up duration (seconds)": 4.0,
"Kill pop-up fade-in animation (seconds, 0 = off)": 0.25,
"WEB - Enable Module": true,
"WEB - Mode (json, http, both)": "both",
"WEB - HTTP Port": 28020,
"WEB - API Key (empty = no auth)": "",
"WEB - JSON Export Interval (seconds)": 30,
"WEB - Leaderboard rows per tab": 10,
"WEB - Server Type (e.g. Vanilla, Modded, PvE)": "Vanilla",
"WEB - Table Number Format (none, K, M, KM)": "KM",
"WEB - Table Number Decimal Places": 1,
"WEB - Profile XP Number Format (none, K, M, KM)": "KM",
"WEB - Profile XP Decimal Places": 2,
"WEB - Chat Auth Mode (steam, played, readonly, open)": "steam",
"WEB - Chat History Lines (0=none, -1=separate tab)": 50,
"WEB - Chat cache (ram, file)": "ram",
"WEB - Chat cache file - max lines (when cache=file)": 1000,
"WEB - Chat Web prefix in game": "[WEB]",
"WEB - Chat Web prefix color (hex)": "#4a90d9",
"WEB - Icon SteamID (0 = none)": 76561199874842386,
"WEB - Chat Session timeout (minutes)": 120,
"WEB - Chat Max message length": 200,
"WEB - Chat Rate limit (messages per minute)": 10,
"WEB - Social - Facebook URL (empty = hide)": "",
"WEB - Social - Instagram URL (empty = hide)": "",
"WEB - Social - TikTok URL (empty = hide)": "https://www.tiktok.com/@koldrix.group",
"WEB - Social - Discord URL (empty = hide)": "https://discord.gg/46QPXh5yzV",
"WEB - Social - TeamSpeak3 address host:port (empty = hide)": "voip.koldrix.com:9987",
"WEB - Social - label prefix (empty = no label)": "Sociale:",
"WEB - Map update interval (seconds)": 2.0,
"WEB - Map image refresh interval (seconds, 0=never)": 0.0,
"WEB - Map file path override (leave empty for auto-detect)": "",
"WEB - Map sea margin (units added by rendermap on each side, default 500)": 500,
"VOTE - Enable Module": true,
"VOTE - RustMaps API Key": "",
"VOTE - Map Size Min": 3000,
"VOTE - Map Size Max": 3750,
"VOTE - Map Size Step": 250,
"VOTE - Map Options": 3,
"VOTE - Use Staging Maps": false,
"VOTE - Wipe Schedule": "",
"VOTE - Read Schedule From Tags": true,
"VOTE - Wipe Weekday": 4,
"VOTE - Wipe Hour": 17,
"VOTE - Days Before Wipe": {
"monthly": 7,
"biweekly": 5,
"weekly": 3
},
"VOTE - Auto Close At Wipe": true,
"VOTE - Auto Open Window": true,
"VOTE - Close Before Wipe (minutes)": 60,
"VOTE - Save Map Images To Disk": true,
"VOTE - Allow Vote Change": true,
"VOTE - Who Can Vote (all, players)": "all",
"VOTE - Show Panel On Connect": true,
"VOTE - Show On Connect Delay (sec)": 10.0,
"VOTE - Yield To Info Panel": true,
"VOTE - Announce Winner": true,
"VOTE - Write Winner File": true,
"VOTE - Winner File": "MajestatTopVote_nextmap.json",
"VOTE - Set Convars On Winner": false,
"VOTE - Winner Command": "",
"VOTE - Chat Commands": [
"vote",
"glosuj"
],
"VOTE - Icon SteamID (0 = none)": 76561199874842386,
"VOTE - Broadcast Start": true,
"VOTE - Broadcast Interval (min)": 60,
"VOTE - Broadcast Before Open": true,
"VOTE - Broadcast Before Open (days)": 2,
"VOTE - Msg Start": "<color=#4cf>[Vote]</color> Ruszyło głosowanie na mapę! Wpisz /vote. Map do wyboru: {maps}",
"VOTE - Msg Time Left": "<color=#4cf>[Vote]</color> Do końca głosowania zostało {time}. Wpisz /vote",
"VOTE - Msg Starts In": "<color=#4cf>[Vote]</color> Głosowanie na mapę rozpocznie się za {time}.",
"VOTE - Time Show Days": true,
"VOTE - Time Show Hours": true,
"VOTE - Time Show Minutes": true,
"INFO - Enable Module": true,
"INFO - Plugin title": "INFORMACJE O SERWERZE",
"INFO - Title color (RGBA 0-1)": "0.3 0.85 1 1",
"INFO - Tab bar width (fraction)": 0.21,
"INFO - Default tab id": "rules",
"INFO - Commands (chat)": [
"help",
"info",
"rules",
"regulamin"
],
"INFO - Show on first connect (auto-open)": true,
"INFO - Show on every connect (ignore dismissed flag)": false,
"INFO - Delay on connect (seconds)": 3.0,
"INFO - Require permission (majestattopcore.info)": false,
"INFO - Tabs": [
{
"id": "rules",
"label": "Regulamin",
"icon": "📋",
"color": "0.2 0.6 0.9",
"lines": [
"…"
]
}
],
"INFO - Icon SteamID (0 = none)": 76561199874842386,
"INFO - Broadcast": {
"Enabled": true,
"Interval minutes": 15.0,
"Tag (e.g. [INFO])": "[INFO]",
"Tag color (#RRGGBB)": "#2ec4f0",
"Nick (sender name)": "Serwer",
"Nick color (#RRGGBB)": "#ffffff",
"Message text color (#RRGGBB)": "#cccccc",
"Messages (cycled in order)": [
"Wpisz /help aby zobaczyć informacje o serwerze.",
"Sprawdź rankingi wpisując /top.",
"Pamiętaj o zapoznaniu się z regulaminem (/help → Regulamin).",
"Dołącz do naszego Discorda! Link znajdziesz w /help → Kontakt."
]
}
}
CORE — field reference#
Database
| Key | Type | Default | Description |
|---|---|---|---|
Database Mode (JSON, SQLITE, MYSQL) |
string | "JSON" |
Statistics storage engine: JSON (file in oxide/data), SQLITE (local database), MYSQL (remote database — requires the MySQL fields below). |
MySQL Host |
string | "localhost" |
MySQL server address (MYSQL mode only). |
MySQL Port |
int | 3306 |
MySQL port. |
MySQL Database Name |
string | "rust_stats" |
Database name. |
MySQL User |
string | "root" |
Database user. |
MySQL Password |
string | "password" |
Database password. |
Language (pl/en) |
string | "pl" |
One language for the whole plugin (since 4.0.0): web panel headers and texts, vote messages, network (NET) messages, console command replies. Replaces the former WEB - Language…, VOTE - Language and NET - Language (pl/en) — on first start the value is carried over automatically (order: WEB → NET → VOTE) and the old keys disappear. Since 4.1.0 every in-game text (the /top panel, pop-ups, banners, XP table) follows this key too — the player's client language only with Language - follow player's game language = true. |
Language - follow player's game language (since 4.1.0) |
bool | false |
false = every player sees the language from Language (pl/en). true = the player's game language: pl… → Polish, en… → English, anything else → Language (pl/en). Up to 4.0.4 the plugin always behaved like true, and Oxide returns the server language (en) for players with no language set — hence English bits despite "pl". Since 4.1.0 every in-game text (tabs, headers, buttons, XP table, banners, web panel) uses one language. |
Panel and leaderboards
| Key | Type | Default | Description |
|---|---|---|---|
Enable Panel |
bool | true |
Main switch of the in-game leaderboard panel (CUI). false = /top, /fame, /topgather, /topbuild etc. do not open the window. Statistics are still counted and saved. |
Enable Fame Leaderboard (/fame) |
bool | true |
Enables the Fame (all-time) leaderboard and the /fame* commands. |
Reset Season Stats On Wipe (4.2.2) |
bool | false |
true = after a map wipe the plugin resets season stats of all players by itself (like mtopcore.resetall: season and progress towards XP thresholds go to zero, Fame stays). Wipe = a new world save (the OnNewSave hook or a save creation date different from the one stored in data/MajestatWipe.json) — it also catches a wipe done while the plugin was off. Reset once, right after the database loads; console: [Wipe] New map save detected - seasonal stats reset…. The first start of 4.2.2 only stores the date (no reset). A blueprint-only wipe is not a map wipe. false = the season lasts until an admin resets it (/mtopreset, mtopcore.resetall). The Majestat network is not affected — it has its own leaderboards. |
Enable XP (4.2.1) |
bool | true |
Master XP switch. false = nothing awards XP (kills, headshots, distance, play time, gathering, loot, building, world, vehicles); the XP / PVP XP / Friendly fire columns in TOP (game and web), the XP TABLE button, /xpinfo, the XP INFO tab on the website, the XP under the name on the web profile, progress bars and "+XP" banners disappear. The kill pop-up stays, without XP amounts. Friendly fire penalties do not apply. TOP is sorted by play time only. The server cannot be verified. |
Enable PvP Stats (4.2.1) |
bool | true |
Master switch for player-vs-player stats. false = PvP kills and deaths are not counted (no XP, pop-up, death.pvp.* breakdown), hits on players do not count towards accuracy, PvP friendly fire does not apply. The PvP kills, PvP deaths and PVP XP columns disappear regardless of their Show … Column. PVP_KILLS sorting then works like XP. The server cannot be verified. |
Leaderboard Sorting Mode (XP, PVP_KILLS, PLAY_TIME) |
string | "XP" |
Sorting criterion of the season leaderboard. Play time breaks ties; with Enable XP = false always play time (4.2.1). Module tabs sort by their TOTAL. |
Fame Leaderboard Sorting Mode (…) |
string | "XP" |
Sorting criterion of the Fame leaderboard. |
PvP tab column visibility — every Show … Column field (bool) shows/hides one column in the PvP panel (since 4.0.0 RC1 Show Play Time Column hides the playtime column on all tabs of the in-game panel): Total XP, PvP XP (4.2.1), PvP Kills, PvP Deaths, PvE Deaths, Heli Kills, Bradley Kills, Scientist Kills, Zombie Kills, Animal Kills, Friendly Fire, Play Time. All true by default. The Show Friendly Fire Column column shows the total count of friendly fire incidents (PvP + PvE) — in the in-game panel (TOP /top) and in the web leaderboard — in red.
XP points for events (compatible with 2.9.2) — how much XP a single event adds:
| Key | Default | Description |
|---|---|---|
Points Per PvP Kill |
5 |
per player kill |
Points Per Zombie Kill |
2 |
per zombie |
Points Per Animal Kill |
1 |
per animal |
Points Per Bradley Kill |
20 |
per Bradley |
Points Per Heli Kill |
20 |
per patrol helicopter |
Points Per Scientist Kill |
3 |
per scientist |
Play Time - Minutes per award |
30 |
how many minutes of playtime per XP award (1–1440) |
Play Time - XP per award |
1 |
XP for each playtime threshold; 0 = off |
Migration: the former
Points Per 30 Min Play Time(XP per 30 min) is moved toPlay Time - XP per awardon first start and the key disappears from the file. On a verified server both playtime parameters are set by the global network. After crossing the threshold the player gets a banner or a chat message (XP - Award notice).
XP for long-range kills
For the longest measured shot at a killed victim, XP is added in proportion to the distance. Applies to PvP, scientist, zombie and animal kills (Heli/Bradley and friendly fire do not give distance XP). Formula: floor(distance / step) * rate.
| Key | Type | Default | Description |
|---|---|---|---|
Points Per Distance Step (extra per step; 0 = off) |
int | 1 |
XP for every full distance step. 0 = distance XP off (the metres line in the pop-up may still show). |
Distance Step (m) for distance XP + pop-up |
int | 100 |
Step size in metres. At 100 m: 214 m → 2 steps → +2 XP; 99 m → 0 XP; 350 m → +3 XP. |
Show Distance Line In Kill Pop-up |
bool | true |
Show the "Distance N m" + XP line in the pop-up. The line appears only when the shot gives at least 1 XP for distance (≥ one step, default ≥ 100 m). Below the threshold there is no line. |
Verified server. With
NET - Master Integration = truethe global network can set its own distance XP rate and step; if it doesn't, the plugin uses the config values. The record for the longest shot goes to the global ranking (MASTER mode only). Distance XP is always awarded locally (also in LOCAL).
Friendly fire — XP penalty for killing an ally / friendly NPC
The server can punish "shooting your own". The penalty is subtracted from the XP.Total pool (season) and from Fame, never below 0. 0 XP = feature off (the kill counts normally).
| Key | Type | Default | Description |
|---|---|---|---|
Friendly Fire - PvP XP Penalty (0 = off) |
int | 0 |
XP penalty when a player kills another player from the same team (Team), clan (Clans) or a friend (Friends). 0 = off → the kill counts as normal PvP. |
Friendly Fire - PvE XP Penalty (0 = off) |
int | 0 |
XP penalty when a player kills a friendly NPC from the list below (e.g. waterwell_shopkeeper). 0 = off → the NPC is classified as before. |
Friendly Fire - Friendly NPC prefabs (substring match) |
list\<string> | see below | Fragments of prefab names treated as friendly NPCs ("contains" match). Default: waterwell_shopkeeper, shopkeeper, bandit_shopkeeper, missionprovider. |
What happens when friendly fire is detected:
- the killer loses XP (
-N) instead of gaining it — no kill reward, - the killer sees a red pop-up "FRIENDLY FIRE!" with the victim's name, the weapon and the
-N XPpenalty, - the killer gets a
PvP.FriendlyFireorPvE.FriendlyFirecounter, - in PvP friendly fire the victim still gets
PvP.Deaths(they died) and the event goes into "last death", - on a verified server the incident is also sent to the global network.
Verified server. With
NET - Master Integration = truethe friendly fire penalties can be set by the global network (including0= FF off in the network) — like all other XP rates. If the network doesn't set them, the plugin uses the config values. The effective values and their source (MASTER / LOCAL) are shown bymtopcore.xpdiagand in the plugin log.
Where friendly fire shows up
Friendly fire appears in three places, in two forms — as an incident counter (how many times) and as XP points (penalty):
- In-game TOP (CUI) and the web leaderboard — the FRIENDLY FIRE column (red) with the total PvP + PvE incident count. Switch:
Show Friendly Fire Column. In the player's web profile (the PVP / PVE card) friendly fire is split into "players" and "NPCs". - INFO /
/xpinfo(XP table, in game and on the web) — friendly fire as XP points in the form of a-N XPpenalty (in red), in the kills section.
XP source: LOCAL / MASTER RATES / MASTER (all or nothing) (updated in 4.2.0)
A server has one, consistent XP mode — rates are never mixed:
| Mode | Condition | XP rates | Player stats to the network |
|---|---|---|---|
| MASTER | NET - Master Integration = true, a full set of rates from the network, a valid NET - Token and a verified server |
from the network | yes |
| MASTER RATES (since 4.2.0) | integration on and a full set of rates from the network, but no token, token rejected or server not verified | from the network (XP counted by the plugin) | no |
| LOCAL | NET - Master Integration = false or the network did not send a full set of rates |
from the config | no |
There is no "partly network, partly config". The server stays visible on the rustserverlist.online list (status, players, chat, Pulse) in every mode.
When the requirements are met again, the server changes mode on its own and, in MASTER, sends the pending player statistics. The active mode is shown by the badge in the in-game and web panel (since 4.2.2 one badge in the leaderboard and the XP TABLE: green "● VERIFIED • XP: MASTER", orange "◐ NOT VERIFIED • XP: MASTER" — MASTER RATES mode, blue "○ NOT VERIFIED • XP: LOCAL"; up to 4.2.1: "● VERIFIED • MASTER" / "◐ MASTER RATES • NOT VERIFIED" / "○ LOCAL"), in the startup line Majestat ready [OK][MASTER|MASTER RATES|LOCAL], in the log (the plugin prints the reason: in LOCAL — why the rates come from the config, in MASTER RATES — why player stats are not sent) and in mtopcore.xpdiag (the Player stats: line). The /api/xpinfo endpoint returns a source field (master with network rates — also in MASTER RATES — or local) and a friendlyFire { pvp, pve, source } object.
XP for sources — Gather.*, Loot.*, Build.* (XP per threshold)
The field value is XP for every full threshold from
XP - Amount per award. Example:Gather.Wood = 1and threshold10000→ 1 XP for every 10,000 wood (12,000 wood = 1 XP + 2,000 progress towards the next threshold). A source without a threshold (or with threshold 1) works as before: XP for every unit — that is the default for Loot and Build. You usually change only the XP; the thresholds have sensible defaults.
Field Type Default Description XP - Amount per award (units per XP award)map see the config example How many units per XP award, per source. Missing key = 1. XP - Award notice (banner/chat/off)string bannerNotification after crossing a threshold: a banner at the top of the screen (like a kill), a chat message, or nothing. offonly withNET - Master Integration = false; with integration on,off=banner. Only sources with a threshold > 1.NET - Master Integrationbool trueOn = XP and thresholds from the global network when it has sent a full set of rates (since 4.2.0 also without verification — MASTER RATES mode; player stats go to the network only after verification). false= your own XP settings from the config.Amounts in the notification are always effective — on a verified server they show the network threshold (e.g. 500 wood), not the local one (10,000). That way the local config does not affect what the player sees and what counts in the network.
Loot and Build have default thresholds and XP
1.0(e.g. 50 Elite Crates = 1 XP). Setting an item's XP to0turns it off; a value > 0 activates its threshold.Totals:
Loot.TotalandBuild.Totalgive XP for every threshold of crates opened / items placed of any type in total (default 100 = 1 XP). They count in parallel with the detailed items — placing a wall advances both Walls and Total. To reward only the total, set the detailed items' XP to0; to reward only the items, set the total's XP to0.Missing thresholds are filled in with defaults on start (existing ones stay). Removing a key from the map no longer turns on "XP per unit" — set threshold
1for that.|
XP - Progress bar| bool |true| A small progress bar towards the next threshold at the bottom of the screen ("8,000 / 10,000" above the bar). Disappears after 5 s without progress. | |XP - Progress bar position Y| float |0.115| Bottom edge of the bar as a fraction of the screen height (above the hotbar). Increase it if it overlaps other plugins' UI. |Where progress is stored: in
oxide/data/MajestatProgress. The file is protected — editing it or moving it from another server resets progress (gives no XP). ChangingNET - Server IDalso resets progress.With network rates (MASTER and MASTER RATES) the plugin takes the threshold and XP from the global network; local values are not overwritten and are used again in LOCAL mode. Threshold progress is shared (switching MASTER → LOCAL does not reset progress). A season reset clears progress.
Updating from older versions: the existing
Gather.*field changes meaning from "XP per unit" to "XP per threshold". If you hadGather.Wood = 1(1 XP for every wood), after the update it is 1 XP per 10,000 wood. The newGather.HQMandGather.Dieselfields are added with a default of1.0— if gathering should not give XP, set them to 0.
These rates used to be hidden in the XP Sources (managed automatically) dictionary. Now they are regular config fields (type double) — you edit them directly. At 0.0 an activity gives no XP (but is still counted in statistics/leaderboards). After changing a value reload the plugin for it to take effect.
-
Gather.Wood,Gather.Stone,Gather.Metal,Gather.HQM,Gather.Sulfur,Gather.Food,Gather.Scrap,Gather.Diesel— XP per threshold of gathered resource.Gather.Food(since 4.2.0) = any item in the game's Food category, obtained by gathering (wild plants, crops, coconuts, meat from corpses) or taken from world crates (cans, bars, bread etc.) — without seeds and clones; hemp gives cloth (farming), not food.Gather.Metal= Metal Ore without HQ;Gather.HQM= HQ Metal Ore — a separate resource (HQ is not counted into Metal, neither in the statistic nor in XP).Gather.Diesel— diesel barrels from the ground, crates and nodes; outsideGather.Total. Scrap and diesel from vending machines, player boxes, the TC and player corpses are not counted; scrap from a recycler is (recycler output only). -
Loot.EliteCrate,Loot.MilitaryCrate,Loot.LockedCrate(Heli / Bradley),Loot.HackableCrate(Locked Crate — CH47 / Oil Rig),Loot.Airdrop,Loot.UnderwaterCrate,Loot.FoodCrate(food boxes/crates),Loot.VehicleCrate(vehicle parts),Loot.NormalCrate,Loot.Barrel— XP for opening a given type of crate/barrel. -
Loot.Total— XP per threshold of crates/barrels opened in total (any type). -
Build.Walls,Build.Foundation,Build.Floors,Build.Roof,Build.Doors,Build.Turrets,Build.Traps,Build.Electrical,Build.Water,Build.Industrial— XP for placing a given base element. -
Build.Total— XP per threshold of elements placed in total (any type).- The former
Build.Pipes(water + industrial together) has been split intoBuild.Water(pumps, tanks, rain catchers, purifiers, sprinklers, shower, fluid switch/splitter/combiner) andBuild.Industrial(conveyors, industrial crafter, storage adaptor, industrial splitter/combiner).doorcontrollergoes to Electrical (not Doors). OldBuild.Pipesvalues stay in the data and inBuild.Total, but the column is no longer shown.
- The former
-
Ships, fishing, recycling, gambling, farming (since 4.1.0, farming since 4.2.0) — XP per threshold (as above), used in LOCAL mode (MASTER RATES uses the network's thresholds). Since 4.2.0 all default to
1.0, exceptGamble.Wagered.Total=0— only a new config gets the new values; in an existing one change them manually, or delete the keys and reload the plugin:Ship.Ships(launched ship, threshold 1 = XP for each),Ship.Hull,Ship.Floor,Ship.Wall,Ship.Stairs,Ship.Door,Ship.Sail,Ship.Engine,Ship.Steering,Ship.Cannon,Ship.Anchor,Ship.Other,Ship.Total(all parts, withoutShip.Ships);Fish.Casts(casts),Fish.Catfish,Fish.OrangeRoughy,Fish.Salmon,Fish.SmallShark,Fish.SmallTrout,Fish.YellowPerch,Fish.Anchovy,Fish.Herring,Fish.Sardine,Fish.Junk,Fish.Total(all fish, without casts and junk);Recycle.Cycles,Recycle.Items,Recycle.Scrap(recycled scrap also gives XP viaGather.Scrap— set0to avoid counting it twice),Recycle.HQM,Recycle.Metal,Recycle.Cloth;- (4.2.2)
Recycle.ShredCars— XP for shredded cars (5 cars = 1 XP by default, network thresholdShred.Cars);Card.Used.Green,Card.Used.Blue,Card.Used.Red— XP for every successful swipe of a keycard of that colour (own KEYCARDS group in the XP table; network thresholdsCard.Used.*, no XP by default); Gamble.Rounds.Total(all games played, 1 XP / 100 games),Gamble.BigWheel.Rounds,Gamble.Slots.Rounds,Gamble.Blackjack.Rounds,Gamble.Wins.Total,Gamble.Wagered.Total(default0: XP for wagered scrap means buying XP with scrap). There is no XP for profit;- (4.2.0)
Farm.Cloth,Farm.AnimalFat,Farm.Leather,Farm.Bone,Farm.Mushroom,Farm.Pumpkin,Farm.Corn,Farm.Wheat,Farm.Potato,Farm.Berry,Farm.Milk(per milking),Farm.Wool(per shearing),Farm.Total(everything except milking and shearing). Default thresholds: cloth and bone 1000, fat and leather 500, crops 20, berries 50, milking and shearing 10, total 1000. Farming counts in parallel withGather.Food— if you give XP for both, crops give XP twice.
Ship - Launched ship prefab keywords (empty = auto)(since 4.1.0, list of strings, empty by default) — prefab name fragments of a launched ship. Empty = automatic detection. If launches are not detected,mtopcore.worldlastlists the candidates — put a fragment of their prefab here.In MASTER mode XP for these sources is counted by the network (thresholds from the network admin panel). The plugin then shows the progress bar and the "+XP" banner for information only and does not add that XP locally (no double counting). In MASTER RATES mode (4.2.0) the network does not receive player stats, so the plugin adds the XP itself — using the network's thresholds. New keys are added to an existing config with default values. Bar colours: green = gathering, gold = loot, blue = building, teal = ships, light blue = fish, purple = recycling, red = gambling, light green = farming.
The former
XP Sources (managed automatically)key is gone from the file — you set rates only in the fields described above.
Saving / cache / number format
| Key | Type | Default | Description |
|---|---|---|---|
Auto-Save Interval (seconds) |
float | 60.0 |
How often (in seconds) "dirty" player profiles are saved (JSON mode: one write of the whole file per cycle). |
Unknown NPC fallback category (…) |
string | "animal" |
Which category unclassified NPCs go to: animal / scientist / zombie / none. Since 4.0.2 such an NPC is sent to the network with its in-game name and the network admins assign it to the right type. Animals from the new-generation AI are recognised automatically. |
Log Level (all, system, alert, none) |
string | "system" |
all = everything (kills, gather, build + system), system = starts/registrations/updates (clean logs), alert = only errors and available updates, none = silence. |
Leaderboard Cache TTL (seconds) |
float | 30.0 |
How long leaderboard results are cached. Since 4.0.0 RC1 the leaderboard (in game and on the web) refreshes at exactly this rhythm — single events no longer clear the cache. |
Max rows per leaderboard tab |
int | 10 |
How many rows one in-game leaderboard tab shows. |
Number Format (none, K, M, KM) |
string | "M" |
Number shortening: none (123456789), K (from thousands: 1.2k), M (from millions: 1.2M), KM (both). |
Number Format Decimal Places |
int | 1 |
Decimal places when shortening (0–3). |
Removed from CORE (compared to old versions):
XP Sources (managed automatically)(replaced by the explicitGather./Loot./Build.fields),Auto-reload modules on Core reload,Auto-reload delay between modules,Auto-reload module order— after the full merge there are no separate modules to reload. Since 4.0.0 RC1 also removed from the code. With a broken config, Core makes a*.broken-YYYYMMDD-HHMMSScopy and does not overwrite the file.
HUD — on-screen panel#
| Key | Type | Default | Description |
|---|---|---|---|
HUD - Enabled (4.2.3) |
bool | true |
The HUD panel (see HUD panel). false = nobody sees it, /hud replies that it is off. |
HUD - Default on for new players (4.2.3) |
bool | true |
true = panel visible, a player hides it with /hud; false = hidden, a player turns it on with /hud. |
HUD - Position (top-right, top-left, middle-right, middle-left) (4.2.3) |
string | "top-left" |
Side (left / right) and height (top / middle of the screen). Top-left by default (since 4.2.5; top-right in 4.2.3). An existing config keeps its value. |
HUD - Offset X (pixels from the side edge) (4.2.3) |
float | 8 |
Spacing from the side edge. |
HUD - Offset Y (pixels down from the top / middle) (4.2.3) |
float | 10 |
Spacing down from the top or the middle of the screen. On the right set about 60 so the panel sits below the game icons. |
HUD - Show world events (4.2.3) |
bool | true |
The world events row (HELI, APC, CARGO, CH47, DROP, VENDOR). |
HUD - Event icons URL (https, empty = network site, off = text) (4.2.3) |
string | "" |
Folder with the icons (heli.png, apc.png, cargo.png, ch47.png, drop.png, vendor.png), https only. Empty = the network site, off = captions only. |
HUD - Refresh interval (seconds) (4.2.3) |
float | 3 |
How often the panel checks for changes (it redraws only when the content changed). |
HUD - Achievements (4.2.3) |
bool | true |
Majestat network achievements in the HUD (needs NET - Master Integration). |
HUD - Achievement banner seconds (4.2.3) |
float | 4 |
How long the unlocked achievement banner stays. |
HUD - Achievements list seconds (4.2.3) |
float | 4 |
How long the list of closest achievements stays. |
HUD - Achievements refresh (seconds) (4.2.3) |
float | 180 |
How often (min. 60) the plugin asks the network about an online player's achievements. |
NET — global network (cross-server ranking)#
| Key | Type | Default | Description |
|---|---|---|---|
NET - Token |
string | "" |
Verification token: My account → "Request verification" → it arrives in Messages. Bound to NET - Server ID; without it the server is not verified (/global unavailable). |
NET - Verified notice (both/broadcast/banner/off) |
string | "both" |
How verification is announced. |
NET - Icon SteamID (0 = none) |
ulong | 76561199874842386 |
SteamID64 whose avatar is the icon of network messages. 0 = default Rust icon. The former key NET - Chat icon SteamID64 (0 = none) — the value is carried over automatically. |
NET - Admin / Owner SteamID64 |
string | "" |
SteamID of the server owner/admin. |
NET - Server ID (empty = auto) |
string | "" |
ID of the server's entry in the network. If the server is already listed — enter the ID from its profile (Server settings → "Server ID"), otherwise a second entry is created. Empty = auto: (4.2.5) the plugin asks the network whether the server is listed and writes the entry's ID here (or a new ID when it is not listed); a server verified before gets its token back at the same time. |
NET - Server type |
string | "modded" |
Server type reported to the network. |
NET - Wipe schedule |
string | "monthly" |
Wipe schedule: monthly / biweekly / weekly. |
NET - Web panel port |
int | 28020 |
Web panel port reported to the network. |
NET - Web panel URL (empty = auto) |
string | "" |
Public web panel address — used to build the "Web panel" link and the links to player profiles. Set it when the panel is behind a reverse proxy (e.g. Nginx Proxy Manager): enter a domain such as rust.example.com or https://rust.example.com. A bare domain gets https:// (a bare IP — http://). Empty = http://<server IP>:<NET - Web panel port>/. |
NET - Update channel (stable/dev) |
string | "stable" |
Update check channel through the Majestat network: stable — production releases only; dev — also test builds (-dev, -beta…). A version with a - suffix always checks the dev channel. Since 4.0.4. |
NET - Verification reminder (minutes, 0 = off) (4.2.5) |
int | 30 |
How often (in minutes) the console and online admins in chat get a reminder that the server meets the Majestat standard and can request verification (/verify, mjnet.verify). Only when the server has no token or sent request. 0 = no reminders. |
Removed from NET:
Net - Game Port— the game port is always taken fromserver.port.
WEB — web panel, chat, map#
| Key | Type | Default | Description |
|---|---|---|---|
WEB - Enable Module |
bool | true |
Web module switch. false = the HTTP server, JSON export and map do not start. |
WEB - Mode (json, http, both) |
string | "both" |
json (data file export only), http (web server only), both. |
WEB - HTTP Port |
int | 28020 |
Port of the web panel HttpListener (must be open). |
WEB - API Key (empty = no auth) |
string | "" |
Key for the API endpoints (empty = no authorization). Recommended when the web panel port is reachable from the internet. |
WEB - JSON Export Interval (seconds) |
int | 30 |
How often (in seconds) to export data to a file (json/both mode). |
WEB - Leaderboard rows per tab |
int | 10 |
How many rows in the leaderboard table on the web page. |
WEB - Server Type (e.g. Vanilla, Modded, PvE) |
string | "Vanilla" |
Server type shown on the web. |
WEB - Table Number Format (none, K, M, KM) |
string | "KM" |
Number format in web tables. |
WEB - Table Number Decimal Places |
int | 1 |
Decimal places in tables. |
WEB - Profile XP Number Format (none, K, M, KM) |
string | "KM" |
XP number format in the player profile. |
WEB - Profile XP Decimal Places |
int | 2 |
Decimal places of profile XP. |
WEB - Chat Auth Mode (steam, played, readonly, open) |
string | "steam" |
steam (Steam sign-in), played (only players who played on the server), readonly (view only), open. |
WEB - Chat History Lines (0=none, -1=separate tab) |
int | 50 |
How many chat history lines; 0 = none, -1 = separate tab. |
WEB - Chat cache (ram, file) |
string | "ram" |
Where to keep the chat cache. |
WEB - Chat cache file - max lines (when cache=file) |
int | 1000 |
Line limit with the file cache. |
WEB - Chat Web prefix in game |
string | "[WEB]" |
In-game prefix for messages from the web (admin: <prefix>[ADMIN], team: [TEAM]<prefix>). Works since 4.0.0 RC1. |
WEB - Chat Web prefix color (hex) |
string | "#4a90d9" |
Colour of the WEB prefix (admin messages are always #e07840). |
WEB - Chat Session timeout (minutes) |
int | 120 |
Web session expiry. |
WEB - Chat Max message length |
int | 200 |
Maximum length of a message from the web. |
WEB - Chat Rate limit (messages per minute) |
int | 10 |
Messages per minute limit from the web. |
WEB - Icon SteamID (0 = none) |
ulong | as NET | SteamID64 whose avatar is the icon of web-chat messages shown in game. 0 = default Rust icon. (since 4.1.1) |
WEB - Social - Facebook/Instagram/TikTok/Discord URL |
string | — | Links for the social icons (empty = hide that icon). |
WEB - Social - TeamSpeak3 address host:port |
string | voip…:9987 |
TS3 address (empty = hide). |
WEB - Social - label prefix (empty = no label) |
string | "Sociale:" |
Label before the icons (empty = no label). |
WEB - Map update interval (seconds) |
float | 2.0 |
How often to refresh positions on the web map (min. 0.5 s). Works since 4.0.0 RC1 (previously fixed at 2 s). |
WEB - Map image refresh interval (seconds, 0=never) |
float | 0.0 |
Map image refresh (0 = never). |
WEB - Map file path override (…) |
string | "" |
Manual map file path (empty = auto). |
WEB - Map sea margin (…) |
int | 500 |
Sea margin added by rendermap on each side. |
Removed from WEB:
Wipe Schedule (e.g. Co tydzien w czwartek)(the schedule in the info bar comes from the server tags:weekly/biweekly/monthly/daily). Since 4.0.0 RC1 also removed:Global PVP page URL(the GLOBAL button leads to the network's global ranking page anyway),Map Show sleeping players for adminandMap Mini-chat height (px)— they never had any effect.
VOTE — next-wipe map vote#
| Key | Type | Default | Description |
|---|---|---|---|
VOTE - Enable Module |
bool | true |
Vote switch. false = the scheduler, the /vote commands and the vote panel do not start. |
VOTE - RustMaps API Key |
string | "" |
RustMaps API key (required to draw maps). |
VOTE - Map Size Min / Max / Step |
int | 3000 / 3750 / 250 |
Range and step of the drawn map size. |
VOTE - Map Options |
int | 3 |
How many maps to choose from (2–6). |
VOTE - Use Staging Maps |
bool | false |
Whether to use staging maps. |
VOTE - Wipe Schedule |
string | "" |
Manual schedule override (monthly/biweekly/weekly; empty = auto from tags). |
VOTE - Read Schedule From Tags |
bool | true |
Read the schedule from the server tags. |
VOTE - Wipe Weekday |
int | 4 |
Wipe weekday (0 = Sun … 4 = Thu). |
VOTE - Wipe Hour |
int | 17 |
Wipe hour. |
VOTE - Days Before Wipe |
object | {monthly:7, biweekly:5, weekly:3} |
How many days before the wipe to open the vote, depending on the schedule. |
VOTE - Auto Close At Wipe |
bool | true |
Close the vote automatically at wipe. |
VOTE - Auto Open Window |
bool | true |
Open the vote window automatically. |
VOTE - Allow Vote Change |
bool | true |
Whether a player may change their vote. |
VOTE - Who Can Vote (all, players) |
string | "all" |
Who can vote: all = everyone; players = only players with a record on this server. Enforced by the plugin for the panel and for the network. |
VOTE - Show Panel On Connect |
bool | true |
Show the vote panel after joining. |
VOTE - Show On Connect Delay (sec) |
float | 10.0 |
Delay before showing the panel. |
VOTE - Yield To Info Panel |
bool | true |
Give the Info panel priority on join. |
VOTE - Announce Winner |
bool | true |
Announce the winning map. |
VOTE - Write Winner File |
bool | true |
Write the winner to a file. |
VOTE - Winner File |
string | MajestatTopVote_nextmap.json |
Name of the winner file. |
VOTE - Set Convars On Winner |
bool | false |
Set convars once the winner is picked. |
VOTE - Winner Command |
string | "" |
Command run once the winner is picked. |
VOTE - Chat Commands |
list | ["vote","glosuj"] |
Commands that open the vote panel. |
VOTE - Icon SteamID (0 = none) |
ulong | 76561199874842386 |
SteamID64 whose avatar is the icon of vote messages. 0 = default Rust icon. The former key VOTE - Icon SteamID — the value is carried over automatically. |
VOTE - Broadcast Start / Interval (min) / Before Open / Before Open (days) |
— | true / 60 / true / 2 |
Vote announcements (start, every how many minutes, notice before opening and how many days ahead). |
VOTE - Msg Start / Msg Time Left / Msg Starts In |
string | (Polish) | Message texts. Variables: {maps}, {time}. |
VOTE - Time Show Days / Hours / Minutes |
bool | true |
Which units to show in the countdown. |
INFO — /help panel / rules + broadcast#
| Key | Type | Default | Description |
|---|---|---|---|
INFO - Enable Module |
bool | true |
Info module switch. false = the /help panel and the broadcast do not start (the /help, /info, /rules, /regulamin commands are not registered). |
INFO - Plugin title |
string | "INFORMACJE O SERWERZE" |
Header of the Info window (default in Polish — e.g. "SERVER INFO"). |
INFO - Title color (RGBA 0-1) |
string | "0.3 0.85 1 1" |
Title colour (RGBA 0–1, space-separated). |
INFO - Tab bar width (fraction) |
float | 0.21 |
Width of the tab bar (fraction of the window width). |
INFO - Default tab id |
string | "rules" |
Tab opened by default (must match an id in INFO - Tabs). |
INFO - Commands (chat) |
list | ["help","info","rules","regulamin"] |
Chat commands that open the panel. |
INFO - Show on first connect (auto-open) |
bool | true |
Open the panel automatically on the player's first join. |
INFO - Show on every connect (ignore dismissed flag) |
bool | false |
true = show on every join, ignoring "don't show again". |
INFO - Delay on connect (seconds) |
float | 3.0 |
Delay of the auto-open after joining. |
INFO - Require permission (majestattopcore.info) |
bool | false |
true = the panel requires the majestattopcore.info permission. |
INFO - Tabs |
list of objects | 4 tabs | Panel tabs. Each: id, label, icon, color (RGB 0–1), lines (content). lines supports Rust rich-text tags: [b], [i], [color=#hex], [size=N], [url=…], [img]url[/img]. Empty list = 4 default tabs. |
INFO - Icon SteamID (0 = none) |
ulong | 76561199874842386 |
SteamID64 whose avatar is the icon of Info messages and the chat broadcast. 0 = default Rust icon. Until 4.0.0 this was the Avatar SteamID (…) field inside INFO - Broadcast — the value is carried over automatically. |
INFO - Broadcast |
object | — | Periodic chat announcements (described below). |
INFO - Broadcast (nested object):
| Key | Default | Description |
|---|---|---|
Enabled |
true |
Enables the broadcast. |
Interval minutes |
15.0 |
How many minutes between messages. |
Tag (e.g. [INFO]) |
"[INFO]" |
Tag prefix before the text. |
Tag color (#RRGGBB) |
"#2ec4f0" |
Tag colour. |
Nick (sender name) |
"Serwer" |
Sender name. |
Nick color (#RRGGBB) |
"#ffffff" |
Sender name colour. |
Message text color (#RRGGBB) |
"#cccccc" |
Message text colour. |
Messages (cycled in order) |
list | Messages rotated in order. |
Data files#
In oxide/data/ (Carbon: carbon/data/):
| File | What it contains | Can I edit it? |
|---|---|---|
MajestatCore.json |
Player statistics in JSON mode (season + Fame). With a broken file the plugin pauses auto-save so it does not overwrite your data with nothing | carefully, with the plugin unloaded |
MajestatCore.db |
Statistics in SQLite mode | — |
MajestatTop.json |
Data from the old 2.9.2 version — migrated once (only players missing from the new data) | — |
MajestatProgress |
Progress towards XP thresholds and incomplete playtime minutes (protected file) | no — any change resets progress for everyone |
MajestatQueue |
Statistics waiting to be sent to the global network | no |
MajestatShips |
IDs of ships counted as launched this wipe — a reload / restart does not count a ship twice. Cleared on a new wipe (since 4.1.0) | yes — existing ships will not be counted again |
MajestatEvents |
Events (e.g. vote, chat) waiting to be sent to the global network | no |
MajestatServerId |
Permanent server identifier in the network (overridden by NET - Server ID if set) |
no |
MajestatVerify |
(4.2.5) Key of a /verify or token recovery request, until the token is picked up |
no |
MajestatHud.json |
(4.2.3) Players' HUD state and earned achievement IDs (so a banner is not shown twice) | no |
MajestatTopWeb.json |
Leaderboard export every WEB - JSON Export Interval (json/both mode) |
output file |
MajestatTopWeb_chat |
Web chat history (only with WEB - Chat cache = file) |
yes |
MajestatTopVote_session |
Current vote session (maps, votes, winner) | not during a vote |
MajestatTopVote_nextmap.json |
Winning map of the next wipe (name from VOTE - Winner File) |
output file |
MajestatTopVoteMaps/ |
Saved map images from the vote (mtv_<size>_<seed>.png) |
old ones can be deleted |
MajestatTopInfo_dismissed |
Players who ticked "don't show on start" in the Info panel | yes |
In MySQL mode statistics live in the majestat_stats table (keys compatible with 2.9.2) and majestat_dynamic_stats (all other keys, value = season, fame_value = Fame).
A season reset (/mtopreset, mtopcore.reset*) clears the current wipe's statistics and XP threshold progress, but Fame (all time) stays.
Performance and runtime behaviour#
| What | How often | Notes |
|---|---|---|
| Profile auto-save | Auto-Save Interval (60 s) |
JSON: one file write per cycle; SQL: queries only for changed players |
| Leaderboard cache | Leaderboard Cache TTL (30 s) |
The in-game and web leaderboard may lag by at most this much |
| Playtime → XP | every 60 s | Closing online sessions of players |
| Cleanup | every 60 s | Hit counters for the pop-up (> 90 s), counted crates (> 2 h) |
| Live map | WEB - Map update interval (2 s) |
One pass over the server's entities; off when WEB is off |
| JSON export | WEB - JSON Export Interval (30 s) |
Only json/both mode |
| Sync with the global network | every 60 s (player statistics every 5 min and when a player leaves) | Without a token — server status only |
| Update check | every 6 h (since 4.0.4 through the Majestat network; a new release is announced right away from the heartbeat) | Result in the web panel footer and in the console (with a download link) |
Frequently asked questions (FAQ)#
Does MajestatTopCore work on Carbon?#
Yes. The plugin runs on Oxide (uMod) and Carbon without any code changes. On Carbon upload the file to carbon/plugins/; the config is in carbon/configs/MajestatTopCore.json and you reload the plugin with c.reload MajestatTopCore.
Is the plugin free?#
Yes, MajestatTopCore is free. The latest version and an archive of every release are on the Download page.
How do players open the leaderboard in game?#
With /top (PvP tab). The other tabs: /gather, /loot, /build; the all-time leaderboard: /fame. /xpinfo shows the XP table. The in-game panel can be turned off with the Enable Panel switch.
How do I reset statistics after a wipe?#
In game /mtopreset confirm (admin); from the console or RCON mtopcore.resetall for all players, or mtopcore.reset <steamid|nick> for one player. A reset clears season statistics and XP threshold progress; the Fame (all-time) leaderboard stays. Since 4.2.2 you can automate it: Reset Season Stats On Wipe = true — the plugin detects a map wipe by itself (also one done while it was off) and resets the season for all players; Fame stays.
Why is my server in LOCAL or MASTER RATES mode instead of MASTER?#
MASTER mode needs three things at once: NET - Master Integration = true, a valid NET - Token and a verified server. The token is bound to the entry's ID, so it must match NET - Server ID. Since 4.2.0 a server with integration on but without verification runs in MASTER RATES mode — XP with the network's rates, but player stats do not reach the global ranking. The plugin prints the reason in the console next to the Majestat ready [OK][LOCAL] / [OK][MASTER RATES] line, and mtopcore.xpdiag shows the effective rates and whether player stats are sent to the network.
Why can't my server be verified?#
Since 4.2.1 verification is blocked by: disabled XP (Enable XP = false), disabled PvP stats (Enable PvP Stats = false) and a hidden TOP column required by the Majestat network. The reason is shown on the server page in the network (Edit) and in the console ([Net] Verification blocked by local settings). Turn these options on, run mtopcore.reloadcfg and request verification again.
The web panel does not open — what should I check?#
That WEB - Enable Module = true, that the WEB - HTTP Port (default 28020) is open in the firewall and at your host, and that WEB - Mode is http or both. If the panel is behind a reverse proxy, put its public address in NET - Web panel URL so the links on the server list lead to the right place.
How do I verify a server without copying the token?#
Since 4.2.5 type /verify in the game (server admin) or mjnet.verify in the console. After the request is approved the token saves itself to NET - Token. Check the state with mjnet.verify status.
My server shows up on the list twice. How do I fix it?#
Set NET - Server ID to the ID of the entry you want to keep (Server settings → "Server ID"), reload the plugin and delete the other entry. Details: Connecting to the Majestat network.
Are statistics lost when the global network is unavailable?#
No. Every event is counted locally, and statistics for the global network wait in MajestatQueue and are sent once the connection is back.