Giggitybyte / SleepWarp

Minecraft Fabric mod which speeds up time when sleeping instead of skipping directly to day.
Mozilla Public License 2.0
14 stars 7 forks source link

Explanation of config #26

Open Mudxiej opened 1 year ago

Mudxiej commented 1 year ago

When I install this mod on a server, I really don't know what first two and last two lines are doing. Do I have to put higher number or lower it, to increse the speed of grow? Just overall - please make an explanation that can help others choose what do they want to set, bc i think I am as others - confussed

Server .config:

{
  "max_ticks_added": 40,
  "player_multiplier": 0.6,
  "action_bar_messages": true,
  "use_sleep_percentage": true,
  "tick_block_entities": true,
  "tick_random_block": true,
  "tick_snow_accumulation": true,
  "tick_ice_freezing": true,
  "tick_lightning": true,
  "tick_monsters": false,
  "tick_animals": false,
  "monster_tick_multiplier": 0.25,
  "animal_tick_multiplier": 0.25
}
Giggitybyte commented 1 year ago

Apologies for not responding to this sooner; I've been away for a week.

At the end of every world tick SleepWarp will try to add max_ticks_added amount of ticks to the world time; the default is 40 ticks, or two seconds (20 ticks = 1 second). The actual amount of ticks added to the time is scaled depending on the number of players sleeping and how many players are connected in total. You can tweak the player_multiplier value to change the exponential curve.

This is what the scale curve looks like on a graph where c is player_multiplier, p is the percentage of players sleeping, and m is max_ticks_added: https://www.desmos.com/calculator/dh0lwtz9ig The output in the fourth box would be the actual amount of ticks added to the world time. All of the world simulation options will be ticked at the same rate as the amount of time added.

animal_tick_multiplier and monster_tick_multiplier will scale the amount of times animals and monsters are ticked relative to the amount of ticks added to the time; with the default settings of 0.25 with one player connected, animals and monsters would be ticked 10 times instead of a full 40 times (40 x 0.25 = 10). Setting the multiplier to 1.0 would tick mobs at the same rate as the amount of ticks added to the time. The defaults are set this way so mobs aren't flying across the screen, which would make fighting monsters much more difficult.

I'll write up a wiki page on this repo detailing more of the specifics some time soon, since a handful of people seem to be confused on the config options.