From 1f4c009d0659813126e0f67ca7a6e89c48de505c Mon Sep 17 00:00:00 2001 From: Crystal Spider Date: Wed, 1 Jan 2025 17:20:29 +0100 Subject: [PATCH] Update README.md and CHANGELOG.md --- CHANGELOG.md | 10 ++++++++++ README.md | 36 +++++++++++++++++++++++------------- 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e35966b..a93ec13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,15 @@ and this project adheres to [Crystal Nest Semantic Versioning](https://crystalne - Port to 1.21.4. +## [v5.0.0] - 2025/01/01 + +- 1.21 and above only. +- Updated to support Cobweb v1.3.0 and SSP v2.0.0. +- This is a BREAKING CHANGE! The Nightworld dimension will be reset. +- It's now possible to change the item required to light up Nightworld portals. +- Changed the namespace (from `server_sided_portals` to `nightworld`) under which configuration tags must be located. +- Added compatibility with `BetterNether` mod (1.21 and 1.21.1 only, as `BetterNether` is not available for later versions at the time of writing). + ## [v4.0.1] - 2024/12/16 - Ported to 1.21.3. @@ -77,6 +86,7 @@ and this project adheres to [Crystal Nest Semantic Versioning](https://crystalne [Unreleased]: https://github.com/crystal-nest/nightworld +[v5.0.0]: https://github.com/crystal-nest/nightworld/releases?q=5.0.0 [v4.0.1]: https://github.com/crystal-nest/nightworld/releases?q=4.0.1 [v4.0.0]: https://github.com/crystal-nest/nightworld/releases?q=4.0.0 [v3.0.0]: https://github.com/crystal-nest/nightworld/releases?q=3.0.0 diff --git a/README.md b/README.md index 877d389..fdcf7cd 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,14 @@ It's a perfect choice for both multiplayer servers who need the nighttime but ca - Similarly to Nether portals spawning zombified piglins, Nightworld portals can spawn zombies and skeletons! - Respawn anchors work just fine! - You can change the portal frame block to anything you like (yes, even multiple blocks!) with a simple datapack! +- You make so that only specific item(s) are able to light up Nightworld portals with a simple datapack! ## **Datapack** -To create a datapack that changes the portal frame block you have to follow a few simple steps: +To create a datapack configuration you have to follow a few simple steps: 1. Create a datapack following [this guide](https://minecraft.wiki/w/Tutorials/Creating_a_data_pack). -2. Under `server_sided_portals` namespace, define a block tag called `nightworld.json` that contains: +2. If you want to tweak the portals frame, define under `nightworld` namespace a block tag called `nightworld_portal_frame.json` that contains: ```jsonc { "replace": true, @@ -40,25 +41,34 @@ To create a datapack that changes the portal frame block you have to follow a fe ] } ``` +3. If you want to tweak the portals igniter, define under `nightworld` namespace an item tag called `nightworld_portal_igniter.json` that contains: + ```jsonc + { + "replace": true, + "values": [ + // List of item IDs + ] + } + ``` That's all! ## **Compatibilities** -| Mod | Loader | Compatibility | -|:---------------------------------------------------------------|:------:|:------------------------------------------------------------------------------------------------------------------------------:| -| [Crying Portals](https://modrinth.com/mod/crying-portals) | All | Incompatible | -| [Immersive Portals](https://modrinth.com/mod/immersiveportals) | All | Incompatible | -| [BetterNether](https://modrinth.com/mod/betternether) | Fabric | Incompatible | -| [Very Many Players](https://modrinth.com/mod/vmp-fabric) | Fabric | Compatible with `use_async_portals=false` | -| [Canary](https://modrinth.com/mod/canary) | Forge | Compatible with [fast portals](https://github.com/AbdElAziz333/Canary/wiki/Configuration-File#mixinaipoifast_portals) disabled | +| Mod | Loader | Compatibility | +|:----------------------------------------------------------------------------------------|:------:|:------------------------------------------------------------------------------------------------------------------------------:| +| [Crying Portals](https://www.curseforge.com/minecraft/mc-mods/crying-portals) | All | Incompatible | +| [Immersive Portals](https://www.curseforge.com/minecraft/mc-mods/immersive-portals-mod) | All | Incompatible | +| [BetterNether](https://www.curseforge.com/minecraft/mc-mods/betternether) | Fabric | Compatible since `1.21` | +| [Very Many Players](https://www.curseforge.com/minecraft/mc-mods/vmp-fabric) | Fabric | Compatible with `use_async_portals=false` | +| [Canary](https://www.curseforge.com/minecraft/mc-mods/canary) | Forge | Compatible with [fast portals](https://github.com/AbdElAziz333/Canary/wiki/Configuration-File#mixinaipoifast_portals) disabled | ## **Dependencies** -| Mod | Loader | Requirement | -|:----------------------------------------------------------------------|:------:|:-----------:| -| [Cobweb](https://modrinth.com/mod/cobweb) | All | Required | -| [Server Sided Portals](https://modrinth.com/mod/server-sided-portals) | All | Required | +| Mod | Loader | Requirement | +|:------------------------------------------------------------------------------------------|:------:|:-----------:| +| [Cobweb](https://www.curseforge.com/minecraft/mc-mods/cobweb) | All | Required | +| [Server Sided Portals](https://www.curseforge.com/minecraft/mc-mods/server-sided-portals) | All | Required | ## **License and right of use**