docs: Update readme, write changelog and bump version number to `v1.1…

…1.0` Also added Natan822 and wMarciano to the contributors. Co-Authored-By: Natan822 <[email protected]> Co-authored-by: wMarciano <[email protected]>
steves-underwater-paradise · Sep 8, 2024 · 422ba24 · 422ba24
1 parent 0a0061a
commit 422ba24
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## `v1.11.0` - 08/09/2024
+
+### Added
+
+- Support for Minecraft 1.21-1.21.1
+- Support for Forge/NeoForge
+- A config option to disable the vignette whilst sleeping
+  - Client-side
+
+### Changed
+
+- Dropped support for Minecraft 1.20.2-1.20.6
+- Lowered the default tick speed multipliers for interactions
+
 ## `v1.10.2` - 05/01/2024
 
 ### Changed

diff --git a/CHANGELOG_LATEST.md b/CHANGELOG_LATEST.md
@@ -1,3 +1,11 @@
+### Added
+
+- Support for Minecraft 1.21-1.21.1
+- Support for Forge/NeoForge
+- A config option to disable the vignette whilst sleeping
+    - Client-side
+
 ### Changed
 
-- Updated Russian translation (by [MushroomMif](https://github.com/MushroomMif) in [PR #57](https://github.com/Steveplays28/realisticsleep/pull/57))
+- Dropped support for Minecraft 1.20.2-1.20.6
+- Lowered the default tick speed multipliers for interactions
diff --git a/README.md b/README.md
@@ -22,52 +22,63 @@ This mod is featured in ["Minecraft Mod Combinations That Work Perfectly Togethe
 
 - [ModMenu](https://modrinth.com/mod/modmenu) for an in game configuration screen (only for singleplayer/LAN)
 
-## Incompatibilities  
+## Incompatibilities
 
 Any mods that add sleep voting, or otherwise modify the sleeping mechanic itself will not work with this mod.  
 You can set a minimum amount of players that have to sleep using the vanilla Minecraft gamerule `PLAYERS_SLEEP_PERCENTAGE`.
 
-Any mods which simply add buffs/debuffs after waking up should work. [Create an issue](https://github.com/Steveplays28/realisticsleep/issues/new) on the issue tracker if you've found an incompatibility!
+Any mods which simply add buffs/debuffs after waking up should
+work. [Create an issue](https://github.com/Steveplays28/realisticsleep/issues/new) on the issue tracker if you've found an incompatibility!
 
-- [BetterSleeping Revived](https://modrinth.com/mod/bettersleeping-revived) - Buffs, debuffs, and chat messages don't trigger (see [issue #18](https://github.com/Steveplays28/realisticsleep/issues/18) for more details)
+- [BetterSleeping Revived](https://modrinth.com/mod/bettersleeping-revived) - Buffs, debuffs, and chat messages don't trigger (
+  see [issue #18](https://github.com/Steveplays28/realisticsleep/issues/18) for more details)
 - [Time and Wind](https://www.curseforge.com/minecraft/mc-mods/time-wind) - Adjusted time snaps back to vanilla time
 - [Time Control](https://modrinth.com/mod/time-control) - Adjusted time snaps back to vanilla time
 
 ## Download
 
-[![github](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/github_vector.svg)](https://github.com/Steveplays28/realisticsleep)
-[![modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/mod/realisticsleep)
-[![curseforge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/mc-mods/realisticsleepfabric)
+[![github](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/github_vector.svg)](https://github.com/steves-underwater-paradise/stevesrealisticsleep)
+[![modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/mod/stevesrealisticsleep)
+[![curseforge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/curseforge_vector.svg)](https://www.curseforge.com/minecraft/mc-mods/stevesrealisticsleep)
 
 ![fabric](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/supported/fabric_vector.svg)
 ![quilt](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/compact/supported/quilt_vector.svg)
 
 See the version info in the filename for the supported Minecraft versions.  
 Made for the Fabric and Quilt modloaders.  
-Server side (with optional client side support for the cloud speed multiplier).
+Server side (with optional client side support for the cloud speed multiplier and a sleep vignette config option).
 
 ## FAQ
 
-![forge](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/unsupported/forge_vector.svg)
-
 - Q: Will you be backporting this to lower Minecraft versions?  
-A: No.
-
-- Q: Forge pls?  
-A: Also no.
+  A: No.
 
 - Q: Does this mod work in multiplayer?  
-A: Yes! The speed of the night scales linearly for each player that's sleeping at the same time.
+  A: Yes! The speed of the night scales for each player that's sleeping at the same time. The scale curve can be changed in the config.
 
 - Q: Does only the server need this mod or does the client need it too?  
-A: Only the server needs this mod (but it works on the client too if you're going to host LAN or play singleplayer). There's optional clientside support for the cloud speed multiplier.
+  A: Only the server needs this mod (but it works on the client too if you're going to host LAN or play singleplayer). There's optional
+  clientside support for the cloud speed multiplier and a sleep vignette config option.
 
 - Q: Can you still avoid rain/thunder by sleeping?  
-A: Yes. After sleeping until dawn the weather will become clear. I might make this configurable in the future, let me know if you want this.
+  A: Yes. After sleeping until dawn the weather will become clear. I might make this configurable in the future, let me know if you want
+  this.
 
 - Q: Does this mod speed up things like furnaces, redstone, the raid timer, and other (modded) block entities?  
-A: Yes!
+  A: Yes!
+
+## Contributing
+
+If you've encountered a problem or you want to suggest
+features, [create an issue](https://github.com/steves-underwater-paradise/stevesrealisticsleep/issues/new) on the issue tracker.
+
+### Development
+
+- `git clone https://github.com/steves-underwater-paradise/stevesrealisticsleep.git`
+- `cd blinkload`
+- `./gradlew build`
 
 ## License
 
-This project is licensed under LGPLv2.1, see [LICENSE](https://github.com/Steveplays28/realisticsleep/blob/main/LICENSE).
+This project is licensed under LGPLv2.1,
+see [LICENSE](https://github.com/steves-underwater-paradise/stevesrealisticsleep/blob/1.20-1.20.1/LICENSE).
diff --git a/gradle.properties b/gradle.properties
@@ -12,7 +12,7 @@ mod_namespace=steves_realistic_sleep
 mod_name=Steve's Realistic Sleep
 mod_description=Makes sleeping speed up time instead of skipping to day.
 mod_license=LGPL-3.0
-mod_version=1.10.2
+mod_version=1.11.0
 supported_minecraft_version=>=1.21 <=1.21.1
 supported_minecraft_version_name=1.21-1.21.1