Climate API

A powerful engine for weather presets and visual effects. Requires a weather pack like Regional Weather.

Environment / Weather / Ambience API / Library

Climate API

A powerful engine for weather presets and visual effects. Requires a weather pack like Regional Weather.

Use the regional climate to set up different effects for different regions. Control where your effects are activated based on temperature, humidity, wind, position, light level or a completely custom activator. Climate API provides temperature and humidity values on a block-per-block basis that follow the seasons, day / night cycle and random changes. Make it rain, change the sky or poison the player - it's up to you.

Troubleshooting

Generally speaking, most mods should be compatible.

If you notice odd movement speeds or jump heights of players, you should check for mods that also modify player physics. Use a compatibility mod like player_monoids or playerphysics to get rid of this problem. This requires the conflicting mod to also support the chosen compatibility layer.

Mods that modify the sky (including skybox, moon, sun, stars and clouds) are sadly not fully compatible because they conflict with Climate API's sky system. You should deactivate the sky features in either mod. You can do this here using the Override the skybox setting. If you're a mod maker then you can also optionally depend on climate_api and use climate_api.skybox.add_layer(playername, layer_name, options) to register your skybox change in a compatible way. Note that you need at least Minetest v5.2.0 for skybox changes to have any effect.

Important: Conflicting skybox changes include the weather mod included in vanilla Minetest Game. You will want to disable that mod in order to use the more advanced cloud system introduced by Climate API. Head to Settings → All Settings → Games → Minetest Game and set Enable weather to Disabled. This setting will only exist if you are using Minetest Game v5.2.0 or higher.

The following mods have been created specifically with Climate API in mind: - Regional Weather: My own weather pack for climate based weather effects - Moon Phases: Complements weather effects with dynamic sky changes and a full moon cycle - Sailing Kit (Fork): Uses Climate API's new wind system to sail across the sea.

The following mods complement Climate API particularly well: - Lightning: Adds to heavy rain by enabling additional lightning effects - Ambience: Plays some nice ambient sound effects based on where you are.

Chat Commands

Configuration Options

You can find all mod configuration options in your Minetest launcher. Go to Settings → All Settings → Mods → climate_api to change them. Individual weather packs may provide additional configuration options in their respective mod configuration section.

Performance

Weather Effects

Environment

Preferences

Modding Information

Check the api_doc.md for a (currently incomplete) documentation on how to register new weather presets and visual effects. Use my weather presets and effects as an example. Ask in the forum or open an issue if you run into problems. Also check the source code of predefined weather effects because they include usage documentation at the top of each file.

License

Assets in screenshots

Ratings and Reviews

Review

Do you recommend this mod?