☰ Contents: MRsleep
For admins

Configuration

Easiest in the browser: with MRadmin under Server → Main server → Configuration → MRsleep - every setting with an explanation, saving reloads MRsleep right away (permission mradmin.config). Without MRadmin everything is in plugins/MRsleep/config.yml, every option is commented there.

Section The most important settings More
general language (default auto), fallback-language, server-language Languages & messages
sleep percentage (quota, default 50), minimum-sleepers, disabled-worlds, clear-weather; ignore (who is not counted) Sleep quota
sleep.display, sleep.chat Boss bar/action bar/title, colors, hide the vanilla display; sleep message, "Good morning!" Display & chat
nosleep cooldown (15m), max-nights (3), prevent-bed-enter, release-on-quit, broadcast Sleep quota → /nosleep
team-limits How long support and staff may give a bypass or ban at most Team limits
discord Webhook URL, which events are sent, colors Discord & log
updates on/off, source, check interval, notice on join Update check
gui Refresh, quick-select durations, sounds Admin menu
  • Durations: d, h, m, s can be combined (15m, 1h30m, 2d). A plain number counts as minutes.
  • Apply changes: /mrsleep reload - no restart needed.
  • config-version please do not change - MRsleep uses it to know whether the file has to be updated.
  • Broken umlauts („ä“ instead of „ä“)? Set the encoding in your editor to UTF-8.

Language & messages

  • general.language: auto (default): every player gets the language of their Minecraft client, otherwise general.fallback-language (default English).
  • Discord logs have no single recipient - they use general.server-language (default en). On a German server, set general.server-language: de.
  • All messages (chat, display, menus, Discord) are in plugins/MRsleep/lang/<language>.yml in MiniMessage format. An empty message ("") turns it off.
  • Your own language, changing messages and more: Languages & messages.

Update check

MRsleep checks on startup and then every few hours (updates.interval-hours, default 6) whether there is a new version:

  • in the console with a download link,
  • in game for players with mrsleep.admin.update as a clickable notice on join (updates.notify-on-join),
  • any time with /mrsleep version.

Only versions for your Minecraft version are offered. Whoever uses a pre-release is also shown newer pre-releases (otherwise only with updates.beta).

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 - Texts not meant for a single player (Discord logs).

Sleeping

How many players have to sleep to skip the night.

Setting Default Meaning
sleep.percentage 50 % Share of sleepers - Percent of the counted players in a world. Players with mrsleep.exempt are not counted.
sleep.minimum-sleepers 1 At least sleeping - Never more than counted players are online.
sleep.disabled-worlds empty Excluded worlds - MRsleep leaves these worlds alone. The Nether and the End are always excluded.
sleep.clear-weather on Clear the weather - Rain and thunder end with the night (like vanilla).

Who is not counted

These players are not counted in the vote.

Setting Default Meaning
sleep.ignore.spectators on Spectators - Players in spectator mode (like vanilla).
sleep.ignore.sleeping-ignored on Excluded by other plugins - E.g. AFK players marked by an AFK plugin.
sleep.ignore.admin-mode on In admin mode - Needs MRadmin.
sleep.ignore.pvp on In a duel - Players in an MRpvp round or the arena editor. Needs MRpvp and MRadmin.

Display

Where the progress ("1/2 sleeping") is shown.

Setting Default Meaning
sleep.display.mode Bar at the top (bossbar) Show as - The bar at the top is not hidden by the chat window in bed - recommended.
sleep.display.bossbar-color Yellow (yellow) Colour of the bar
sleep.display.bossbar-blocked-color Red (red) Colour when the night is blocked
sleep.display.hide-vanilla-message on Hide Minecraft's message - Minecraft's own "x/y sleeping" counts everyone and does not know MRsleep's rules.
sleep.chat.sleep-message Same world (world) Chat "… went to bed"
sleep.chat.announce-skip on Announce the skipped night - Message to the world when the night was skipped.

/nosleep

Players can block the next night.

Setting Default Meaning
nosleep.cooldown 15m Cooldown - Between two blocks per player. Only starts when the blocked night begins.
nosleep.max-nights 3 nights At most at once - That many nights with /nosleep <number>.
nosleep.prevent-bed-enter off Lock the bed - On: nobody gets into bed in a blocked night (no spawn point). Off: bed yes, the night stays.
nosleep.release-on-quit on Cancel on leaving - The block ends when the player leaves the server.
nosleep.broadcast on Tell everyone - Everyone in the world sees who uses or cancels /nosleep.

Team limits

Longest cooldown bypass and /nosleep ban support and staff may give. Admins (…unlimited) have no limit.

Setting Default Meaning
team-limits.support.bypass 30m Support - bypass
team-limits.support.ban 1d Support - ban
team-limits.staff.bypass 1d Staff - bypass
team-limits.staff.ban 1d Staff - ban

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 MRsleep 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 /nosleep used: Send true · Colour #E67E22
/nosleep cancelled: Send true · Colour #2ECC71
Cancelled on leaving: Send true · Colour #95A5A6
Block expired: Send true · Colour #95A5A6
Night starts blocked: Send true · Colour #34495E
Bed locked: Send true · Colour #E74C3C
Night skipped: Send true · Colour #F1C40F
Team: blocks lifted: Send true · Colour #9B59B6
Team: player released: Send true · Colour #9B59B6
Team: bypass given: Send true · Colour #9B59B6
Team: bypass removed: Send true · Colour #9B59B6
Team: cooldown reset: Send true · Colour #9B59B6
Team: /nosleep banned: Send true · Colour #C0392B
Team: ban lifted: Send true · Colour #27AE60
Team: reloaded: Send true · Colour #3498DB
Events - Which events are sent and in which colour. The texts are in the language files.

Updates

Look for new versions of MRsleep.

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 mrsleep.admin.update get a notice.

Admin menu

The menu /mrsleep gui.

Setting Default Meaning
gui.refresh-ticks 20 ticks Refresh every - 20 ticks = 1 second.
gui.bypass-durations 30m, 2h, 1d Quick choices bypass - Exactly three durations in the player menu.
gui.ban-durations 1h, 1d, permanent Quick choices ban - Exactly three durations, "permanent" = forever.
gui.sounds on Click sounds

Generated automatically from src/main/resources/web-config.yml + config.yml.

✎ Edit on GitHub·docs/wiki/en/konfiguration.md ↗