Easiest in the browser: with MRadmin under Server → Main server → Configuration → MRchunks - every setting with an explanation, saving reloads MRchunks right away (permission mradmin.config). Everything is also commented in plugins/MRchunks/config.yml; you apply changes by hand with /mrchunks reload.
| Section | The most important settings | More |
|---|---|---|
general |
language (default auto), fallback-language, server-language |
Languages & messages |
loaders |
default-budget (147 chunks), default-reach (3 = new loaders 7×7), max-reach (7 = at most 15×15), max-loaders (30), overlap, load-method, restore-missing-blocks |
Chunk budget |
invites |
on/off, duration choices, at most this many members | Friends |
linked-accounts |
on/off, how many alt accounts | Friends |
dummies |
on/off (default off), limit, skin, sitting | Dummy players |
lag-protection · staged-shutdown · server-pause |
Measurement and lock limits, MSPT steps of the staged shutdown, TPS thresholds | Lag protection, Shutdown & pauses |
item · border |
Looks of the loader and the border, item.block-choices: blocks players may choose for their loaders (empty list [] = no choice) |
Using chunk loaders |
player-map |
Layers on the map of the player page (MRadmin): own, others, loader-preview |
Map |
discord · updates · gui |
Logs, update notices, menus | Discord |
- Nether and End: if you enabled
disable-world-ticking-when-emptyin Paper, setloaders.load-method: forceload. config-versionplease do not change - MRchunks uses it to know whether the file has to be updated.
Language & messages
general.language: auto(default): every player gets the language of their Minecraft client, otherwisefallback-language(default English).- Discord logs and tickets in MRadmin have no single recipient - they use
general.server-language(defaulten). On a German server, setgeneral.server-language: de. - All messages - chat, menus, item, player page, Discord - are in
plugins/MRchunks/lang/<language>.yml. An empty message ("") turns it off. More under Languages & messages.
Discord
Create a webhook (Edit channel → Integrations → Webhooks), set discord.enabled: true, enter the webhook-url, /mrchunks reload and check with /mrchunks discord test. Which events are sent (loader placed, deleted, locked, invitations, admin actions …) you set under discord.events.
No own webhook? With MRadmin it also works through its Discord log:
discord.enabled: true, leavewebhook-urlempty and setdiscord.use-mradmin-webhook: true.With MRadmin every event is also in the log of the web interface (up to 14 days) - even when Discord is off.
All settings
Every setting of config.yml with its default - the same fields as in MRadmin's browser form. The list is generated automatically from the plugin and therefore always matches this version.
General
Language of the texts in game and on Discord.
| Setting | Default | Meaning |
|---|---|---|
general.language |
Automatic (auto) |
Language of the players - Automatic = every player gets the language of their Minecraft client. |
general.fallback-language |
English (en) |
Fallback language - For players whose language has no file of its own. |
general.server-language |
English (en) |
Language for Discord and tickets - Texts not meant for a single player: Discord logs, tickets in MRadmin. |
Chunk loaders
Players set the size of their loaders themselves and have a budget in chunks for that. Only active loaders cost budget.
| Setting | Default | Meaning |
|---|---|---|
loaders.default-budget |
147 chunks |
Budget per player - 147 = three 7×7 loaders. More with mrchunks.budget.<number>, mrchunks.budget.unlimited or /mrchunks limit. |
loaders.default-reach |
3 chunks per side |
Size of new loaders - 3 = 7×7, 2 = 5×5, 1 = 3×3, 0 = only its own chunk. If the budget is too small it gets smaller or is placed switched off. |
loaders.max-reach |
7 chunks per side |
Largest reach - 7 = up to 15 chunks wide and long. |
loaders.max-loaders |
30 |
At most placed per player - Switched-off ones count too. The same for everyone. |
loaders.disabled-worlds |
empty | Worlds without chunk loaders - MRpvp's arena world is always blocked (with MRadmin). |
loaders.load-method |
Ticket (ticket) |
Load method - Ticket = recommended. Forceload only if disable-world-ticking-when-empty is active in Paper. |
loaders.overlap |
Allow with a notice (warn) |
Overlapping loaders |
loaders.restore-missing-blocks |
on | Restore missing blocks - E.g. after WorldEdit. Off = the chunk loader is deleted. |
loaders.check-interval-seconds |
60 seconds |
Check blocks every |
loaders.restart-signal.enabled |
on | Redstone signal before restarts - Owners choose in the loader settings whether their loader gives a redstone signal before restarts and stops (or stops giving it then). Needs MRadmin. Players keep seeing their block, only the web map shows a redstone block meanwhile. |
loaders.restart-signal.minutes |
1, 5, 10, 15, 30, 60 minutes |
Minutes before to choose from - The lead times owners switch between with a right click. |
loaders.items-always-active |
on | Items in chunk loaders always active - Items in running loaders always move at full speed, even far from players and dummies (otherwise Paper throttles them outside the activation range - item streams stutter). Costs a little tick time. |
Invites & linked accounts
Invited players may only switch on and off. Linked accounts (e.g. an AFK second account) share loaders and budget.
| Setting | Default | Meaning |
|---|---|---|
invites.enabled |
on | Invites |
invites.durations |
1d, 7d, 30d, permanent |
Durations to choose from - "permanent" = forever. |
invites.max-members |
10 |
At most invited - Per loader or for "all loaders". |
linked-accounts.enabled |
on | Linked accounts |
linked-accounts.max-accounts |
1 |
Second accounts per main account |
linked-accounts.request-seconds |
120 seconds |
Time to accept |
Dummy players
An artificial player on the loader - farms run as with a real player next to them. Costs a lot more performance.
| Setting | Default | Meaning |
|---|---|---|
dummies.enabled |
off | Allow dummies - Only on square loaders from 5×5 with the block in the middle. |
dummies.default-limit |
1 |
At once per player - More with mrchunks.dummies.<number>, .unlimited or /mrchunks limit. |
dummies.sit |
on | Sits on the block - Off = it stands on it. |
dummies.owner-skin |
on | Owner's skin |
Lag protection
Every loader is measured regularly. Above "warn" it counts as suspicious, several times above "lock" only this loader is switched off and locked.
| Setting | Default | Meaning |
|---|---|---|
lag-protection.enabled |
on | Lag protection on |
lag-protection.sample-seconds |
20 seconds |
Measure every |
lag-protection.startup-delay-seconds |
180 seconds |
Wait after the start - Loading the worlds would otherwise lock on every start. Also applies to the shutdown and the pause. |
lag-protection.lock-after-samples |
3 |
Lock after measurements - That often in a row above the lock limit. |
lag-protection.only-when-server-lags |
on | Only lock when the server lags - A big farm the server copes with well then stays on. |
lag-protection.server-lag-mspt |
40 ms |
Server lags from - Average tick time (50 ms = 20 TPS just about held). |
lag-protection.force-lock-multiplier |
3 × lock limit |
Always lock from - Even without server lag. 0 = never without lag. |
lag-protection.lock-suspension-durations |
1h, 3h, 6h, 12h, 24h |
Durations to suspend the lock - At most 7, from 1m to 24h. The longest is also the maximum for /mrchunks suspendlock. |
lag-protection.live-view.enabled |
on | Live measuring on the web - An open loader in MRadmin is measured more often - only shown and never locks. |
lag-protection.live-view.seconds |
1 seconds |
Measure live every |
lag-protection.live-view.max-loaders |
5 |
At most live at once |
lag-protection.limits-per-chunks |
49 chunks |
Limits apply to - 49 = one 7×7 loader. Other sizes get proportionally more or less. |
lag-protection.limits |
Entities (without players): Warn 100 · Lock 250Items on the ground: Warn 150 · Lock 500Redstone changes per second: Warn 500 · Lock 2000Hopper transfers per second: Warn 300 · Lock 1200Piston moves per second: Warn 40 · Lock 150New mobs and items per second: Warn 15 · Lock 50 |
Limits - Warn and lock limit per measurement. 0 switches the measurement off. |
lag-protection.small-loaders.max-chunks |
9 chunks |
Small loaders up to - 9 = 3×3. They get fixed limits, bigger ones never less. |
lag-protection.small-loaders.limits |
Entities (without players): Warn 60 · Lock 150Items on the ground: Warn 60 · Lock 200Redstone changes per second: Warn 150 · Lock 600Hopper transfers per second: Warn 100 · Lock 400Piston moves per second: Warn 15 · Lock 50New mobs and items per second: Warn 6 · Lock 20 |
Limits of small loaders |
Server pause
If the whole server lags, all loaders release their chunks until it has recovered - then they load again by themselves.
| Setting | Default | Meaning |
|---|---|---|
server-pause.enabled |
on | Server pause on |
server-pause.below-tps |
15 TPS |
Pause below |
server-pause.pause-after-seconds |
30 seconds |
That long below |
server-pause.resume-tps |
18 TPS |
Resume from - A bit higher than the pause limit - otherwise the loaders keep switching. |
server-pause.resume-after-seconds |
60 seconds |
That long above |
server-pause.notify-owners |
on | Tell owners and the team |
Staged shutdown
Protects the server against the load of many loaders together: above the limit the loader with the highest load is "disabled by lag", then the next.
| Setting | Default | Meaning |
|---|---|---|
staged-shutdown.enabled |
on | Staged shutdown on |
staged-shutdown.average-seconds |
60 seconds |
Average over |
staged-shutdown.warn-mspt |
40 ms |
Warn from |
staged-shutdown.shutdown-mspt |
45 ms |
Shut down from |
staged-shutdown.step-seconds |
60 seconds |
Next loader after |
staged-shutdown.min-minutes |
5 minutes |
Off at least |
staged-shutdown.max-shutdowns |
2 |
Lock after shutdowns - Whoever is shut down more often within the time below is locked. The hard cap does not count. |
staged-shutdown.window-minutes |
60 minutes |
Within |
staged-shutdown.hard-cap-mspt |
70 ms |
Hard cap - Above it all loaders are disabled at once. 0 = none. |
staged-shutdown.hard-cap-seconds |
10 seconds |
Hard cap - average over |
Item & block
Look of the chunk loader. Name and description of the item are in the language file.
| Setting | Default | Meaning |
|---|---|---|
item.material |
EMERALD_BLOCK |
Material - E.g. EMERALD_BLOCK. Normal blocks of this type are not chunk loaders. |
item.glint |
on | Enchantment glint |
item.block-choices |
DIAMOND_BLOCK, GOLD_BLOCK, IRON_BLOCK, LAPIS_BLOCK, NETHERITE_BLOCK, AMETHYST_BLOCK, WAXED_COPPER_BLOCK, QUARTZ_BLOCK, OBSIDIAN, CRYING_OBSIDIAN, GLOWSTONE, SEA_LANTERN, SHROOMLIGHT, PURPUR_BLOCK |
Blocks to choose from - For "Change block" in the loader menu (mrchunks.block). Only solid blocks without gravity or function. Empty = no choice. |
Border display
Glowing lines at the outer edge, visible through blocks - only for the player themselves.
| Setting | Default | Meaning |
|---|---|---|
border.show-on-open |
off | Show when opening the menu - Otherwise only via the button in the menu. |
border.duration-seconds |
60 seconds |
Visible for |
border.color |
#4CFF7A |
Colour active |
border.block |
LIME_CONCRETE |
Block active |
border.inactive-color |
#A0A8A4 |
Colour switched off |
border.inactive-block |
LIGHT_GRAY_CONCRETE |
Block switched off |
border.thickness |
0.08 blocks |
Line thickness |
border.below |
1 blocks |
Lines down |
border.above |
5 blocks |
Lines up |
border.line-spacing |
3 blocks |
Spacing of the lines |
Map of the player page
Layers on the map of MRadmin's player page (needs MRadmin).
| Setting | Default | Meaning |
|---|---|---|
player-map.own |
on | My chunk loaders - Own and shared ones, a right-click switches them on and off. |
player-map.others |
on | Other chunk loaders - The loaders of all other players (name, owner, size - no actions). |
player-map.loader-preview |
on | Small map at the loader - The loader and its surroundings in its opened card on the player page. |
Discord logs
Send events to a Discord channel. Webhook: Edit channel → Integrations → Webhooks → New webhook → copy URL.
| Setting | Default | Meaning |
|---|---|---|
discord.enabled |
off | Send Discord logs |
discord.webhook-url |
empty | Webhook URL - Starts with https://discord.com/api/webhooks/ |
discord.use-mradmin-webhook |
off | Use MRadmin's webhook - Without a webhook URL of its own, the events go to MRadmin's Discord log. |
discord.username |
MRchunks |
Name in the channel - Empty = setting from Discord. |
discord.avatar-url |
empty | Avatar URL - Empty = setting from Discord. |
discord.use-embeds |
on | Coloured embeds - Off = plain text messages. |
discord.footer |
Minecraft-Server |
Footer - E.g. the server name (empty = none). |
discord.events |
Loader placed: Send true · Colour #2ECC71Loader deleted: Send true · Colour #E67E22Loader on/off: Send true · Colour #3498DBLoader renamed: Send true · Colour #1ABC9CSize changed: Send true · Colour #1ABC9CBlock restored: Send true · Colour #F1C40FDeleted (block missing): Send true · Colour #95A5A6Team: loader deleted: Send true · Colour #C0392BTeam: player banned: Send true · Colour #C0392BTeam: ban lifted: Send true · Colour #27AE60Team: limit changed: Send true · Colour #9B59B6Team: reloaded: Send true · Colour #3498DBInvited: Send true · Colour #1ABC9CInvite withdrawn: Send true · Colour #95A5A6Excluded (mrchunks.exempt): Send true · Colour #E74C3CLoader suspicious: Send true · Colour #F39C12Locked for lag: Send true · Colour #C0392BLag lock lifted: Send true · Colour #27AE60Own limits set: Send true · Colour #3498DBLock suspended: Send true · Colour #3498DBLock applies again: Send true · Colour #95A5A6Server pause: Send true · Colour #E67E22Pause ended: Send true · Colour #27AE60Server under load: Send true · Colour #F39C12Server relaxed again: Send true · Colour #27AE60Disabled by lag: Send true · Colour #E67E22Loading again: Send true · Colour #27AE60Hard cap reached: Send true · Colour #C0392BTeam: all paused: Send true · Colour #E67E22Team: pause lifted: Send true · Colour #27AE60Team: shutdown switched: Send true · Colour #9B59B6Locked after shutdowns: Send true · Colour #C0392BDummy on/off: Send true · Colour #9B59B6Accounts linked: Send true · Colour #1ABC9CLink removed: Send true · Colour #95A5A6 |
Events - Which events are sent and in which colour. The texts are in the language files. |
Updates
Look for new versions of MRchunks.
| Setting | Default | Meaning |
|---|---|---|
updates.enabled |
on | Look for updates - On start and regularly afterwards. A notice appears in the console. |
updates.source |
GitHub (github) |
Source |
updates.beta |
off | Betas too - Also reports beta versions (BET-...). While a 0.x beta runs they are always reported. |
updates.interval-hours |
6 hours |
Check every |
updates.notify-on-join |
on | Tell the team on join - Players with mrchunks.admin.update get a notice. |
Menus
The menus of /chunkloader and /mrchunks.
| Setting | Default | Meaning |
|---|---|---|
gui.refresh-ticks |
20 ticks |
Refresh every - 20 ticks = 1 second. |
gui.confirm-seconds |
5 seconds |
Time for the confirm click - Deleting needs a second click (protection against misclicks). |
gui.ban-durations |
1d, 7d, permanent |
Quick choices ban - Exactly three durations in the admin menu, "permanent" = forever. |
gui.sounds |
on | Click sounds |
gui.max-name-length |
24 characters |
Longest loader name |
Generated automatically from src/main/resources/web-config.yml + config.yml.