Start on NEXT (version 1.0) branch

- update gradle wrapper version (8.4 to 8.5) - update logo and add banner - change to gradle kotlin DSL (from groovy) - update README.md - update project layout for planned forge support - move common logic to common module - change environment to 'client' to prevent servers from loading the mod (#2) - cleanup unneeded files - update LICENSE.md to use Markdown format for easier reading - update version number to prepare for version 1.0 Signed-off-by: Lucas Petrino <nsx1lucas@gmail.com>
2026-01-05 04:57:51 +00:00 · 2024-01-14 19:20:34 +13:00
parent 993df4b93d
commit 4eaf638e42
45 changed files with 804 additions and 683 deletions
--- a/README.md
+++ b/README.md
@@ -1,9 +1,71 @@
-# Weather Changer
-Changes the weather on client side
+<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>

-Supports fabric 1.20.0+, forge support is coming soon!\
-The fabric api is required.
+<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>

-## Links
-Modrinth: https://modrinth.com/mod/weather-changer \
-Curseforge: https://www.curseforge.com/minecraft/mc-mods/weather-changer <br>
+<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>
+
+> Warning: This is the v1.0 (next) branch and is still in development.
+
+## 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.
+
+### 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 keyBase bind 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)
+
+## 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
+
+## Release History
+| Branch | Version | MC Version    | Mod loaders | Git Tag                                                                | CI  | Supported |
+|--------|---------|---------------|-------------|------------------------------------------------------------------------|-----|-----------|
+
+### 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.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.*