Skip to content

Configuration

OffLuffy edited this page Aug 16, 2019 · 1 revision

Global Settings

Setting Description
enable-stats You can disable metrics by setting this to false or by using /ssmetrics in game to toggle it. If enabled, some data is sent to bStats.org.
enable-data-share If enabled, this will send some basic server details to a web server so I can look through some stats on my own. If you've just installed SmoothSleep and generated a new config, no data is transmitted on first load so you have a chance to disable this. Data included here is the server's IP address/port, hostname, version information for the server, bukkit, and SmoothSleep's version.
update-notify-login If this is enabled, staff can be notified when an update is available for the plugin when they login.

Logging options

These are self-explanatory, choose which logging levels to show in the console. I’d recommend against having debug enabled unless you’re trying to find an issue as it can be somewhat overkill.


Per-World Settings

Setting Description
min-night-speed-mult The lowest possible night speed multiplier (if the tiniest fraction of players are sleeping). Keep in mind that SmoothSleep won't affect the speed if no one is sleeping, this only applies if at least one person is asleep. Must be a whole number greater than 0.
max-night-speed-mult highest possible night speed multiplier (if everyone is sleeping). Must be a whole number greater than 0.
night-speed-curve This value allows you to tweak how the ratio of players sleeping affects the speed of night. With values less than 0.5, fewer sleepers will affect the speed less, then as more players sleep, it ramps up more quickly. With values more than 0.5, it's the opposite. At exactly 0.5, it's a linear increase. If you set the value to 0, then night speed will be the min speed until everyone is asleep, then it'll be max speed. If it's 1, then it'll be max speed if anyone sleeps. Only values between 0-1 are accepted. To get a better visualization of how this value works, check out this graph
morning-sound If this is a valid sound, then it will play for a player when they wake up. To disable, leave this blank. For a list of valid sounds, refer to the Sound enum - Bukkit API
clear-weather-when-morning If true, then rain and storms are stopped when it reaches morning if any players are still in bed at that time.
instant-day-if-all-sleeping Self-explanatory. If all non-sleep-ignored players are sleeping, then this will set the time instantly to day while still showing the morning title/subtitle. This is far more instant than vanilla. As soon as the last (or only) person clicks the bed, it will set time to day, unlike how vanilla will wait for you to sit in bed for a few seconds.

Titles

Setting Description
enabled If true, then a title will display the in-game time, the number of players sleeping / total non-sleep-ignored players, and the current night speed multiplier.
morning-title The title shown upon waking up if 'use-titles' is enabled.
morning-subtitle The message shown under the title upon waking up if 'use-titles' is enabled.
sleep-title The title shown while sleeping if 'use-titles' is enabled.
sleep-subtitle The message shown under the title while sleeping if 'use-titles' is enabled.

Action-Bar

Setting Description
enabled If true, then a message will appear above the hot bar with the specified title when players are sleeping. By default, this is used to show sleepers their health/food level while sleeping since the ‘leave bed’ button blocks the normal UI elements in some cases.
show-if-awake Whether or not to show the action bar to players if they’re not sleeping.
title What text to show in the action bar while players are sleeping (supports placeholders)

Boss-Bar

Setting Description
enabled If true, then a boss bar with a title will be displayed at the top of the screen when players are sleeping.
show-if-awake Whether or not to show the boss bar to players if they’re not sleeping.
title What text to show in the boss bar while players are sleeping (supports placeholders)

Morning-Particle-Options

Setting Description
enabled Whether or not to spawn particles in the morning
particle This is the name of the particle you wish to use. Note that particles which require extra data cannot currently be used. If the particle you have chosen requires extra data, you will get some warnings in the console. For a complete list of valid particles, refer to the Particle Enum - Bukkit API
amount This will both change how many particles are shown, and how long the particles are shown. This and the ‘delay-ticks’ setting control how long a particle effect lasts for.
radius This controls how far away from the player you'd like the particles to spawn. The maximum radius is currently 20, simply because larger values don't seem to make much sense.
pattern What shape to spawn the particles in. This can be ‘random’, ‘circle’ or ‘spiral’.
delay-ticks How long in ticks to wait after spawning a set of particles before spawning another. Increase this value if you want to space out how often particles are spawned. This increases how long the effect lasts for.

Replenish-Settings

Setting Description
heal-negative-statuses If true, heals negative status effects if the player has slept the required hours.
hours-to-heal-negative The hours of sleep required to heal negative statuses.
heal-positive-statuses If true, heals positive status effects if the player has slept the required hours.
hours-to-heal-positive The hours of sleep required to heal positive statuses.
ticks-per-health Ticks to sleep (including timescaled ticks) to heal the amount specified. 1000 = 1 in-game hour. A full night lasts just under 10 hours. If you set this to 1000, it'll heal the player 9 times by morning regardless of night speed.
heal-amount The amount healed per interval specified. Can be negative. 1 = half a heart.
heal-awake Whether the heal effect should be applied to players who aren’t sleeping, but in a world where time is being accelerated.
ticks-per-feed Ticks to sleep (including timescaled ticks) to feed the amount specified. Similar to ticks-per-health.
feed-amount Ticks to sleep (including timescaled ticks) to feed the amount specified.
feed-awake Whether the feed effect should be applied to players who aren’t sleeping, but in a world where time is being accelerated.

Sleep-Rewards.Potion-Effects

Setting Description
enabled Whether to enable potion effect sleep rewards
required-sleep-hours How many in-game hours a player needs to sleep to be rewarded
show-effect-particles Whether to show potion effect particles. If shown, particles will be 'ambient'.
effects The list of effects to applied. Each entry under this should be a valid effect name, and have a duration and amplifier value under it. Amplifier starts at 0 for a base level effect. If an effect name is invalid, a message will print to console while initializing.

Essentials-Settings

Setting Description
ignore-afk If true, AFK players will be considered sleep-ignored.
ignore-vanish If true, vanished players will be considered sleep-ignored.

Clone this wiki locally