Superstorm (stormy + flooded + tornado + hurricane)

Snowfall + Majora Moon

Hallowed Eclipse (hallowed + eclipsed)

Impending Storm (none > rainy > cloudy > stormy > hurricane)

Meteor Shower + Blood Moon

Blue Moon (blue + bloodmoon)

Toxic Winds (toxicsmog + tornado)

The End of the World (all weathers)

There is a lot more to discover by yourself 🤗

Registering weathers using the config was meant to be used by users and modpacks makers.

It is higly recommended to use Gale to manage the configs of this mod. Right now, it is the best mod manager when it comes to edit the configs and you'll see why shortly.

To register a new custom weather you need to open the zigzag.combinedweatherstoolkit.cfg config file, then navigate to the Config weathers section.

You will see a config named Weather Config creator: this is the place where you can create your own weather effects. Just below it is an example that can be used to learn what is the accepted data format when creating a weather and here is what it looks like :

Eclipsed + Foggy : Eclipsed : Foggy

The format is very simple as you can see, this line will actually register the combined weather Eclipsed + Foggy into the game and its effect is to combine the Eclipsed and Foggy weathers together.

You can actually add as much value as you want, each one separated by a comma ,. To make the process easier, you can click on the little arrows icon on the right of the config to expand the field :

Then you can very easily add each custom weathers in this new window by clicking on the Edit as list option. In this place you can add as much entries as you want and it's way easier to see what's going on :

This is very nice but what can the config do more ? Well, the config can also accept a custom color and type. Here's all the possible parameters :

Each of these parameters needs to be separated with a colon :, and so if you combine everything you will get something like this in the config :

When it is done, launch the game and go into orbit so WeatherRegistry can generate configs for your weathers. You can then go back in the config, this time the one from WeatherRegistry and edit your weather's configs as you want (weight, filtering, scrap multipliers).

Weathers created using this mod will be listed as WeatherToolkit Weathers in WeatherRegistry's config file.

That's pretty much it ! Hope you can create some crazy effects with this mod 🙂

Registering weathers using .json files was meant to be used by developers.

It was made for developers that want to add special weather combos to their mods, or for moon makers that wants to add a specific custom weather that only spawns on their custom moon.

To register a new custom weather you need to create a json file with a name that will end with .cwt.json. The mod is made to detect and load all .cwt.json that are located in the BepInEx/plugins folder (no matter if it is located in a sub folder or not). This means you can place your files wherever you want in your mod's folder.

You can create as much .json files as you want but it is also possible to do everything inside the same file, it is up to you.

The weather creation in .json files is made in a very user friendly way where you can actually write a very minimal weather or completely configure it with all sorts of options. You can check some json examples in the folder by clicking here so you can learn how to write it but let's still explain how it works :

{
    "example": {
        "type": "Combined",
        "name": "Rainy + Eclipsed + Foggy",
        "color": "#FF0000",
        "weight": 100,
        "scrap_amount": 1.0,
        "scrap_value": 1.2,
        "filtering": false,
        "level_filter": "Company",
        "level_weights": "MoonName@50",
        "weather_to_weather_weights": "WeatherName@50",
        "weathers": [
            "Rainy",
            "Eclipsed",
            "Foggy"
        ]
    }
}

This example property will actually register the combined weather Rainy + Eclipsed + Foggy into the game and its effect is to combine the Rainy, Eclipsed and Foggy weathers together.

If you want to make all your weathers in the same .cwt.json then you simply need to add other properties fields into the file.

A lot of parameters in this example are optional and if it is not specified the mod will calculate automatic default values. The minimum you need to write for it to be valid is the name and the weathers. Here's all the possible parameters :

All of these options are actually coming from WeatherRegistry, I just made them open for combined and progressive weathers if a developer wants to use them.

When it is done, you don't have anything else to do ! Just publish the json files with your mod, make sure that this tool is installed and it will work, there is no need to soft depend on anything !

WeatherRegistry will still generate a unique config for your weather under the WeatherToolkit Weathers section but there is nothing to adjust here since everything is already configured (this can then be customized by users of your mod).

That's pretty much it ! Hope you can create some crazy effects with this mod 🙂