Skip to content

Commit 1f4c009

Browse files
Crystal-SpiderCrystal-Spider
committed
Update README.md and CHANGELOG.md
1 parent 50cabbe commit 1f4c009

File tree

2 files changed

+33
-13
lines changed

2 files changed

+33
-13
lines changed

‎CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ and this project adheres to [Crystal Nest Semantic Versioning](https://crystalne
99

1010
- Port to 1.21.4.
1111

12+
## [v5.0.0] - 2025/01/01
13+
14+
- 1.21 and above only.
15+
- Updated to support Cobweb v1.3.0 and SSP v2.0.0.
16+
- This is a BREAKING CHANGE! The Nightworld dimension will be reset.
17+
- It's now possible to change the item required to light up Nightworld portals.
18+
- Changed the namespace (from `server_sided_portals` to `nightworld`) under which configuration tags must be located.
19+
- 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).
20+
1221
## [v4.0.1] - 2024/12/16
1322

1423
- Ported to 1.21.3.
@@ -77,6 +86,7 @@ and this project adheres to [Crystal Nest Semantic Versioning](https://crystalne
7786

7887
[Unreleased]: https://github.com/crystal-nest/nightworld
7988

89+
[v5.0.0]: https://github.com/crystal-nest/nightworld/releases?q=5.0.0
8090
[v4.0.1]: https://github.com/crystal-nest/nightworld/releases?q=4.0.1
8191
[v4.0.0]: https://github.com/crystal-nest/nightworld/releases?q=4.0.0
8292
[v3.0.0]: https://github.com/crystal-nest/nightworld/releases?q=3.0.0

‎README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,14 @@ It's a perfect choice for both multiplayer servers who need the nighttime but ca
2525
- Similarly to Nether portals spawning zombified piglins, Nightworld portals can spawn zombies and skeletons!
2626
- Respawn anchors work just fine!
2727
- You can change the portal frame block to anything you like (yes, even multiple blocks!) with a simple datapack!
28+
- You make so that only specific item(s) are able to light up Nightworld portals with a simple datapack!
2829

2930
## **Datapack**
3031

31-
To create a datapack that changes the portal frame block you have to follow a few simple steps:
32+
To create a datapack configuration you have to follow a few simple steps:
3233

3334
1. Create a datapack following [this guide](https://minecraft.wiki/w/Tutorials/Creating_a_data_pack).
34-
2. Under `server_sided_portals` namespace, define a block tag called `nightworld.json` that contains:
35+
2. If you want to tweak the portals frame, define under `nightworld` namespace a block tag called `nightworld_portal_frame.json` that contains:
3536
```jsonc
3637
{
3738
"replace": true,
@@ -40,25 +41,34 @@ To create a datapack that changes the portal frame block you have to follow a fe
4041
]
4142
}
4243
```
44+
3. If you want to tweak the portals igniter, define under `nightworld` namespace an item tag called `nightworld_portal_igniter.json` that contains:
45+
```jsonc
46+
{
47+
"replace": true,
48+
"values": [
49+
// List of item IDs
50+
]
51+
}
52+
```
4353

4454
That's all!
4555

4656
## **Compatibilities**
4757

48-
| Mod | Loader | Compatibility |
49-
|:---------------------------------------------------------------|:------:|:------------------------------------------------------------------------------------------------------------------------------:|
50-
| [Crying Portals](https://modrinth.com/mod/crying-portals) | All | Incompatible |
51-
| [Immersive Portals](https://modrinth.com/mod/immersiveportals) | All | Incompatible |
52-
| [BetterNether](https://modrinth.com/mod/betternether) | Fabric | Incompatible |
53-
| [Very Many Players](https://modrinth.com/mod/vmp-fabric) | Fabric | Compatible with `use_async_portals=false` |
54-
| [Canary](https://modrinth.com/mod/canary) | Forge | Compatible with [fast portals](https://github.com/AbdElAziz333/Canary/wiki/Configuration-File#mixinaipoifast_portals) disabled |
58+
| Mod | Loader | Compatibility |
59+
|:----------------------------------------------------------------------------------------|:------:|:------------------------------------------------------------------------------------------------------------------------------:|
60+
| [Crying Portals](https://www.curseforge.com/minecraft/mc-mods/crying-portals) | All | Incompatible |
61+
| [Immersive Portals](https://www.curseforge.com/minecraft/mc-mods/immersive-portals-mod) | All | Incompatible |
62+
| [BetterNether](https://www.curseforge.com/minecraft/mc-mods/betternether) | Fabric | Compatible since `1.21` |
63+
| [Very Many Players](https://www.curseforge.com/minecraft/mc-mods/vmp-fabric) | Fabric | Compatible with `use_async_portals=false` |
64+
| [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 |
5565

5666
## **Dependencies**
5767

58-
| Mod | Loader | Requirement |
59-
|:----------------------------------------------------------------------|:------:|:-----------:|
60-
| [Cobweb](https://modrinth.com/mod/cobweb) | All | Required |
61-
| [Server Sided Portals](https://modrinth.com/mod/server-sided-portals) | All | Required |
68+
| Mod | Loader | Requirement |
69+
|:------------------------------------------------------------------------------------------|:------:|:-----------:|
70+
| [Cobweb](https://www.curseforge.com/minecraft/mc-mods/cobweb) | All | Required |
71+
| [Server Sided Portals](https://www.curseforge.com/minecraft/mc-mods/server-sided-portals) | All | Required |
6272

6373
## **License and right of use**
6474

0 commit comments

Comments
 (0)