<!--suppress HtmlDeprecatedAttribute -->
<p align="center" style="display: block;margin-left: auto;margin-right: auto;margin-bottom: 0">
    <img src="assets/logo-242x242.png" alt="Weather Changer Logo"/>
</p>

<h1 align="center" style="margin-top: 0;margin-bottom: 0">Weather Changer</h1>
<p align="center" style="margin-top: 0;">Client side weather change for Minecraft</p>

<p align="center"><a href="https://www.curseforge.com/minecraft/mc-mods/weather-changer"><img src="https://cf.way2muchnoise.eu/full_682513_downloads.svg" alt="curseforge-downloads"></a>
<a href="https://modrinth.com/mod/weather-changer"><img src="https://img.shields.io/modrinth/dt/nhSHTGyl?logo=Modrinth" alt="modrinth-downloads"></a></p>

<p align="center" style="display: block;margin: 0 auto;">
    <img src="assets/banner.png"  alt="Weather Changer Banner"/>
</p>

## Overview
Changes the weather on client side (only visible to you) to clear, rain, or thunder, this mod does not affect the server or send any packets to the server.

Supports forge and fabric, requires the [Fabric API](https://modrinth.com/mod/P7dR8mSH) when using fabric

### In-Game Command Usage
`/clientweather <off | clear | rain | thunder>`

The command alias `/cweather` may also be used as a shortcut.

### Keybindings
To set the keybindings you can do so in the minecraft keybinding settings.

| Description                                                                      | Default |
|----------------------------------------------------------------------------------|---------|
| Disable the client weather (weather will display the server weather like normal) | Unbound |
| Set the client weather mod to clear                                              | Unbound |
| Set the client weather mod to rain                                               | Unbound |   
| Set the client weather mod to thunder                                            | Unbound |   

For supported mod loaders and minecraft versions see [release history](#release-history)

<!-- modrinth_exclude.start -->

## Download
You can download the mod from any of the platforms below.

**Modrinth (_recommended_)**: https://modrinth.com/mod/weather-changer <br>
**Curseforge**: https://www.curseforge.com/minecraft/mc-mods/weather-changer <br>
**GitHub Releases:** https://github.com/Lucaslah/WeatherChanger/releases <br>
**Release Server**: https://release.cssudii.xyz/projects/weatherchanger

<!-- modrinth_exclude.end -->

## Release History
| Branch | Version | MC Version    | Mod loaders   | Git Tag                                                                | CI                                                                                                                                                                                   | Supported |
|--------|---------|---------------|---------------|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
| main   | v1.0.0  | 1.20.1-1.20.4 | fabric, forge | [1.0.0](https://github.com/Lucaslah/WeatherChanger/releases/tag/1.0.0) | [![Build](https://github.com/Lucaslah/WeatherChanger/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/Lucaslah/WeatherChanger/actions/workflows/release.yml) | Yes       |

### Pre-release (v0) versions
| Branch | Version | MC Version    | Mod loaders | Git Tag                                                                | CI  | Supported |
|--------|---------|---------------|-------------|------------------------------------------------------------------------|-----|-----------|
| N/A    | v0.3.0  | 1.20.1-1.20.4 | fabric      | [0.3.0](https://github.com/Lucaslah/WeatherChanger/releases/tag/0.3.0) | N/A | No        |
| N/A    | v0.2.0  | 1.19.3        | fabric      | [0.2.0](https://github.com/Lucaslah/WeatherChanger/releases/tag/0.2.0) | N/A | No        |
| N/A    | v0.1.0  | 1.19.1-1.19.2 | fabric      | [0.1.0](https://github.com/Lucaslah/WeatherChanger/releases/tag/0.1.0) | N/A | No        |

## Minecraft Versions
| Version | Status                          |
|---------|---------------------------------|
| 1.20.4  | Supported                       |
| 1.20.3  | Supported                       |
| 1.20.2  | Supported                       |
| 1.20.1  | Supported                       |
| 1.20    | Not Supported (available in v0) |
| 1.19.4  | Not Supported (available in v0) |
| 1.19.3  | Not Supported (available in v0) |
| 1.19.2  | Not Supported (available in v0) |
| 1.19.1  | Not Supported (available in v0) |

*Older versions may be added on request*

------------------------------------------
*Licensed under the [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html) license.*
