Configuration Guide

Plugin Version supported by this Guide : v2.0.1

Before saying anything, I hope this configuration guide will help you.
If there is something you want to change (before I'm not always understandable), just say it on the forum !

Quick Description

So the configuration are in the Seasons folder.
There is one config per world.
The name of the config file is based on the world's name.
It's a Yaml configuration so don't use tabs.
The config is in two parted in the file.
The first part is for the Properties of the world (colors, regens, messages)
The second part is for the Seasons.


Properties part

Active

Active can be set to true or false.
If active, the plugin will do his job on this world.
You can set it to false if you want a season free world.

LogInfo

LogInfo can be set at true or false.
If active, it will write on the console each time a season change or a player use a command

Resolution

Precision :

Precision is a double.
It means that there must be a comma "." .
It's the resolution of the displays on the /season for example.
It also modified the plugin's way of counting.

For example, 0.1 will displays message with one number after the comma.

TimeCheck :

TimeCheck is an Integer;
It's the number of ticks between each Seasons's check of time

Regen

The Regen has two parts

Snow :

Snow can be set to true or false.
If active, the snow will be regenerated on snow weather.
you can set it to false if you don't want snow blocks to be spawned on snow weather

Ice :

Ice is the same thing that snow but for the Ice ^^

Messages

It's the place where are the messages that are displayed and the color of them.

ChangeMessage : It's the message displayed on season changes.
It contains <name>, it's the part replaced by the new Season's name.

SeasonsMessage : It's the message displayed on /season
It contains <name> and <number>, they are the part replaced by the Season's name and the Number of remaining days.

SpecialDayMessage : It's the message displayed on a special Day.
It contains <name>, it's the part replaced by the special Day's name.

Weather : It's the message displayed on /season weather
It contains <name>, it's the part replaced by the weather's name.

Color : It's the color of the messages that are displayed by the Season plugin.
Note that the displayed on the console is without color, so it won't color console displays.
Note also that there is also the ColorList.
it's only here for your information, you don't have to change it.

NotActive : It's the message displayed when you try something linked to Seasons plugin in a world where this plugin is not enabled.

Sign : It's the 3 lines that will be displayed on the Seasons signs.
The node you can set are

  • <name> : Current Season name
  • <day> : Number of the day in the current Season
  • <length> : Number of days in the current Season
  • <specialDay> : Name of the current SpecialDay if there is one, nothing else

Debug

Debug is a debug option
For the moment, it only show the random number on each weather change.
Just don't use it, it's useless.


Seasons Part

The Seasons Part is the place where the seasons are configurated.
There are a lot of option to let you create your very own ones.

Season's Name

The first node is for the name your give to your season

Visual

Here are all the options that are linked to Visual Effects

Snow :

Snow can be set from 0 to 100
It's the percentage of rain time replaced by snow time.
You can use it to create Winters Seasons.

Textures :

Textures must contains an URL to a specific texture pack (.zip).
It's the texture pack that will be displayed to the clients on this Season
Note that they can be asked to download the Texture Pack defaulty with the PermissionNode season.textures.default (they can refuse it)
Note also that an empty config for the Textures will only disable this option an leave the players with their own textures

ShortName

It's the shortname you give to your season.
It's used on the command /setseason [shortname].

Lengths

It's an important part of the Season
Here are the lengths in Minecraft-Days for all the things the plugin needs

Season :

It's the whole duration of the season.
Note that it's a double so it have to contains a comma ","

Weather :

It's the Time between each weather changes and each random pick.
Note that it's a double so it have to contains a comma ","

Percentages

Here is the heart of a season.
It's here that are written the percentages of each weather that is randomly picked on each weather change
You must make an amount of 100% for the 3 weather

Sun : It's the Sun Weather Percentage

Rain : It's the Rain/Snow Weather Percentage

Thunder : It's the Thunder Weather Percentage.

SpecialDays

Here is all the Special Days that you can create
A special day is a corresponding to the number of the Season's day followed by the name of this Special Day
Like '2' : "The Day Number 3
You'll surely ask why the number 2 is correspondig to the third day
In fact it's not the third day, it's the end of the second one
If you count the days passed in the season, you can easily understand why.

SnowManagerSpeed

Please first look at the SnowManager Page before use it

The speed corresponds to the number of blocks changes per chunk per second

Place :

The Place node corresponds to the placing speed of snow and ice
It should be between 0.0 and 1.0 (for example 0.5)
You can set it > 1.0, but in that case beware of the clients that may lag

Remove :

The Remove node corresponds to the placing speed of snow and ice
It should be between 0.0 and 1.0 (for example 0.5)
You can set it > 1.0, but in that case beware of the clients that may lag

Time

In this part, there are all the time of a day

Day :

It's the number of ticks of DayTime during the day;
A tick is 1/20 second
For example : 24000 ticks means that the day (sun time) will remain during 20min

Night :

Just the same that the Day but for the Night.


Config Example

Seasons:
  Summer:
    Visual:
      Textures: ''
      Snow: 0
    ShortName: summer
    Lengths:
      Season: 10.0
      Weather: 0.5
    Percentages:
      Sun: 70
      Rain: 20
      Thunder: 10
    SpecialDays:
      '1': First Day of Summer
      '10': Last Day of Summer
    SnowManagerSpeed:
      Place: 0
      Remove: 0
    Time:
      Day: 16000
      Night: 8000
  Winter:
    Visual:
      Textures: ''
      Snow: 100
    ShortName: winter
    Lengths:
      Season: 5.0
      Weather: 0.5
    Percentages:
      Sun: 30
      Rain: 60
      Thunder: 10
    SpecialDays:
      '1': First Day of Winter
      '3': Mid Winter
      '5': Last Day of Winter
    SnowManagerSpeed:
      Place: 0
      Remove: 0
    Time:
      Day: 14000
      Night: 10000
Properties:
  Active: true
  LogInfo: true
  Resolution:
    Precision: 0.01
    TimeCheck: 20
  Regen:
    Snow: true
    Ice: true
  Messages:
    ChangeMessage: Seasons changes to <name>.
    SeasonsMessage: You're in <name> for another <number> days.
    SpecialDayMessage: It's <name>.
    Weather: The current weather is <name>.
    Color: b
    NotActive: Seasons are not active in this world.
    Sign:
    - <name>
    - <day>/<length>
    - <specialDay>
    ColorList:
      BLACK: '0'
      DARK_BLUE: '1'
      DARK_GREEN: '2'
      DARK_AQUA: '3'
      DARK_RED: '4'
      DARK_PURPLE: '5'
      GOLD: '6'
      GRAY: '7'
      DARK_GRAY: '8'
      BLUE: '9'
      GREEN: a
      AQUA: b
      RED: c
      LIGHT_PURPLE: d
      YELLOW: e
      WHITE: f
      MAGIC: k
      BOLD: l
      STRIKETHROUGH: m
      UNDERLINE: n
      ITALIC: o
      RESET: r
  Debug: true