Wikis / MythicSeasons / Installation

Installation

How to install, reload and upgrade MythicSeasons, and the files it creates.

Requirements

Requirement	Value
Server software	Paper, or a server built on Paper
Minecraft	`1.21` to `1.21.11`, and `26.1`, `26.2` and `26.3`
Java	21 or newer

Folia is not supported. Every 26.x version other than 26.1 and 26.2 loads the 26.3 code. On any other newer version the plugin logs MythicSeasons could not start.

Features that need a newer version

Feature	Needs
Seasons, sub-seasons, calendar, events, temperature, crops, biome colours, client-side blocks, weather simulation, MythicMobs support	Any supported version
Volumetric clouds	`1.21.11` or newer. Older versions log `Atmosphere clouds need Minecraft 1.21.11 or newer; cloud layer disabled.`
`attributes` sections in biome files (environment attributes)	`1.21.11` or newer, else ignored with a warning. Only attributes your Minecraft version has work
`PALE_GARDEN.yml`	`1.21.4` or newer, else skipped with a log line

A server build that cannot draw the clouds logs Atmosphere cloud rendering is unavailable on this server build; cloud layer disabled.

Optional plugins

None is required. See Compatible Plugins.

Plugin	What it enables	Without it
MythicMobs	Conditions, mechanics, placeholders, season skill triggers and the bundled pack	No pack and no skill triggers, see MythicMobs
PlaceholderAPI	The `ms` expansion, and placeholders in the temperature action bar and event texts	Those placeholders stay as typed
WorldGuard	Region flags for seasons, weather, wind and temperature	No flags
WorldEdit	Needed by the WorldGuard support	No WorldGuard flags
GriefPrevention	`griefprevention.yml`: seasonal effects and a fixed temperature in claims	No claim handling
dynmap	Pauses map rendering in seasons that ask for it	Nothing is paused
BlueMap	Pauses map rendering in seasons that ask for it	Nothing is paused
MythicProxy	One shared weather per world for a group of servers	Every server simulates its own weather
Multiverse-Core	Load order only	Nothing changes

Installing

Put the MythicSeasons jar into the plugins folder.
Start the server. It creates plugins/MythicSeasons with the files under Files and folders.

Read the console. It logs Loaded season: <id> per season, the optional plugins it found and the worlds with a season:

Integrations active: MythicMobs, PlaceholderAPI
Integrations not installed: WorldGuard, WorldEdit, GriefPrevention, Multiverse-Core, dynmap, BlueMap
No world has seasons yet. Run /ms set <season> in a world to start one.

Once a world has a season, the last line is Seasons active in: <world> (<season id>).

Start a season: as an operator or with mythicseasons.admin, run /ms set <season> [world] with an id from the console (the console has to name the world, see Commands and Permissions). Or set on-new-world-creation.default-season in config.yml to a season id, for overworld-type worlds with no saved state at startup and for worlds created later.

A world's first season also turns on body temperature (if enabled is true in temperature.yml) and the weather simulation (if enabled is true in atmosphere.yml). In a world that default-season gives a season at startup, turn temperature on with /ms temperature toggle <world>.

The weather simulation

The simulation, the clouds and the cloud fog pack are on as shipped (enabled, clouds.enabled and clouds.shader-pack.enabled in atmosphere.yml).

/ms atmosphere toggle [world] turns the simulation off or on in one world.
Install MythicMobs. Players see rain, snow, wind and storms through the pack skill MS_Atmosphere, which a custom season has to list in skill-triggers.player-tick, like the shipped seasons do.
The clouds need Minecraft 1.21.11 or newer. A change to clouds.enabled needs a restart.

See Atmosphere, Clouds and the cloud fog resource pack.

MythicMobs

MythicSeasons copies the bundled pack into plugins/MythicMobs/packs/MythicSeasons/ only at startup, so install MythicMobs before the first start, or restart after you add it.

Without MythicMobs, everything the pack does is missing: temperature changes beyond the air temperature, the readout, warnings and effects of temperature, and the weather effects players see. Seasons, sub-seasons, the calendar, events, biome colours, client-side blocks, the air temperature, crops, the weather simulation and the clouds still work.

Files and folders

Everything below is inside plugins/MythicSeasons.

File	Created	Contents	New keys on update
`config.yml`	First start	General settings and the season cycle. See General Config	Added on every start and reload
`calendar.yml`	First start	Months, weekdays and season dates. See Calendar	A few newer keys are added when missing
`temperature.yml`	First start	The air and body temperature settings. See Temperature	Added on every start and reload
`crops.yml`	First start	Growth speed per plant and season. See Crops	Missing plants and seasons are added on every start and reload
`atmosphere.yml`	First start	The weather simulation and clouds. See Atmosphere	Added on every start and reload
`data.yml`	First start, empty	Saved state: each world's season, date, switches and paused time, and player settings	Not applicable
`griefprevention.yml`	Server load, with GriefPrevention only	Claim settings. See Land Claims	No
`lang/en.yml`	First start	Chat messages. See Language	Added on every start and reload
`commands.yml`	First start	Command names and aliases. See Commands and Permissions	Not written. A missing key takes the bundled value

Folder	Shipped files	Notes
`seasons/`	`winter.yml`, `spring.yml`, `summer.yml`, `fall.yml`, `example.yml`	Every `.yml` is a season. `example.yml` ships with `enabled: false`. See Seasons
`events/`	`christmas.yml`, `newyear.yml`, `halloween.yml`, `easter.yml`, `example.yml`	Every `.yml` except `events.yml` and `custom-events.yml` is an event. `example.yml` ships with `enabled: false`. See Events
`biomes/`	`BADLANDS.yml`, `BEACH.yml`, `BIRCH_FOREST.yml`, `CAVES.yml`, `DARK_FOREST.yml`, `DESERT.yml`, `FLOWER_FOREST.yml`, `FOREST.yml`, `FROZEN_BIOMES.yml`, `FROZEN_MOUNTAINS.yml`, `JUNGLE.yml`, `MOUNTAINS.yml`, `MUSHROOM_FIELDS.yml`, `OCEAN.yml`, `PALE_GARDEN.yml`, `PLAINS.yml`, `RIVER.yml`, `SAVANNA.yml`, `SWAMP.yml`, `TAIGA.yml`, `CUSTOM_EXAMPLE.yml`	The named files cover the vanilla biomes, any other `.yml` is a custom biome file. `CUSTOM_EXAMPLE.yml` (`includes: ALL`) covers every custom biome no other file claims. See Biomes
`cloud-layers/`	`cumulus.yml`, `ground-fog.yml`, `cirrus.yml`, `cirrus-hooks.yml`, `cirrostratus.yml`, `fog-banks.yml`, `mars-dust.yml`, `mars-ice.yml`	One cloud layer per file, named after it. See Cloud Layers
`cloud-styles/`	`soft.yml`, `billowy.yml`, `toon.yml`, `wisp.yml`	One cloud look per file, picked by a layer's `style`. See Styles
`atmosphere-profiles/`	`example.yml`, `mars.yml`	Named skies for seasons, worlds and skills. See Profiles
`debug/`	None	`cloud-dump-<player>-<time>.txt` files from `/ms atmosphere dumpclouds`

Files are copied into these folders only when missing, and never replaced.

With enabled and clouds.shader-pack.enabled on in atmosphere.yml (the defaults), the plugin writes the cloud fog pack <clouds.shader-pack.name>.zip (MythicSeasons-CloudFog.zip by default) into its folder. See Shader Pack.

Outside the plugin folder:

Path	Contents
`plugins/MythicMobs/packs/MythicSeasons/`	The bundled MythicMobs pack. See Packs
`<world folder>/mythicseasons/atmosphere-v1-c<cell-size xz>x<cell-size y>-y<lowest Y>-n<levels>/`	The world's saved weather (`r.<x>.<z>.bin` per region and a `clock` file). A change to a value in the folder name, such as `grid.cell-size`, `grid.y-min` or a `grid.y-max` that changes the number of levels, starts fresh weather and leaves the old folder behind. `grid.max-cells` is not in the name

What MythicSeasons changes in a world

Reloading and restarting

/ms reload re-reads the files in plugins/MythicSeasons, except what the table below lists. It never reads the MythicMobs pack or copies missing pack files: /mm reload re-reads the pack, see Packs.

These need a restart:

File	What
`biomes/`	Everything except the `atmosphere` block
`config.yml`	`biome-display-name`, `optimized-custom-biomes`, `performance.chunk-supplier-interval`, `performance.skill-trigger-interval` and `performance.autosave-interval-minutes`
`atmosphere.yml`	`grid.cell-size`, `grid.y-min`, `grid.y-max`, `timing.step-period-ms`, `timing.time-acceleration`, `physics.solver-threads`, `shared-weather-group` and `clouds.enabled`
`commands.yml`	Every key
`seasons/`	`foliage-transitions`
`cloud-styles/`	The `shader` part of a style
`calendar.yml`	`time-sync-timezone` changed from a named zone back to `system`
`griefprevention.yml`	Every key
`data.yml`	Edit it only while the server is stopped: the plugin rewrites it from memory

Check the console after every reload. Warnings and errors name the file and the key.

When an error stops a reload, /ms reload answers Reload stopped part-way: <error> and the files after the broken one are not reloaded. If config.yml cannot be read, nothing reloads, and at startup MythicSeasons does not start.

Upgrading

Stop the server, replace the jar and start it again.
If the version changed, the console logs config.yml was written by MythicSeasons <old>, this build is <new>. Any new keys have been added with their defaults.
config.yml, temperature.yml, atmosphere.yml and lang/en.yml get every new key with its default. Your values stay.
seasons/, events/, biomes/, cloud-layers/, cloud-styles/ and atmosphere-profiles/ only get missing files, so a file you already have never gets its new shipped version. To get it, rename your copy, restart and merge your edits into the new file.
The MythicMobs pack works the same way, without a warning. See Updating the Pack and, for servers from before the temperature skills, Updating to the temperature skills.
data.yml carries a data-version. An older build reading a newer file logs a warning and ignores what it does not recognise.
custom-events.yml is no longer read. Move its events into one file each in events/.

Usage statistics

MythicSeasons sends anonymous usage statistics to bStats (plugin id 30099), including whether temperature, real-time sync and custom biomes are in use. The global bStats setting turns it off.

Core Plugins