Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Estecka committed Oct 30, 2024
1 parent f4489ff commit 51e17c8
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,16 @@ Like those commands, the menus will only be accessible in worlds with cheats/com
Unlike the vanilla `/datapack` command, the Datapack menu from this mod can be used to toggle experimental features!


## Word of caution: Datapacks
## About Datapacks

Some types of datapacks require a world restart to fully take effect.
Whenever possible, the mod will show a warning after toggling one of them, and offer you the option to either back-out, or exit the world gracefully.
However, some type of packs cannot be detected, and no warning will be displayed for those.
**Experimental features** require a world restart in order to fully take effect. The mod will detect whenever you try to toggle one, and display a warning before exiting the world gracefully.

### Registry Packs
The new type of packs introduced in MC 1.21, those packs which add data to registries (painting variants, etc), **are not detected by the mod**, but still require a world restart to fully take effects.
Since MC 1.21, some regular datapack can add data to registries (painting variants, etc), which also requires a world restart. However, **those packs are not detected by the mod**, so a restart cannot be enforced for those.
A confirmation screen will still be displayed for any and all pack change, giving you the option to exit the world instead of hot-reloading.

Toggling these packs may cause some errors in the log, but those are benign so long as you restart the world immediately afterward. This behaviour is no different from using the `/datapack` command.

### Experimental Features
Packs that include experimental features (such as bundles) are properly detected by the mod. Toggling them will also toggle the corresponding feature-flag on the world, and exit the world gracefully.
Toggling a registry pack without restarting may print some errors in the log, but those are usually benign. This behaviour is no different from using the `/datapack` command.

### Vanilla Datapack
The Vanilla datapack can technically be disabled, but you probably don't want to do it.
Doing so will usually break worlds unless you know exactly what you are doing.
The Vanilla datapack can technically be disabled, but doing so will break worlds unless you know exactly what you are doing.
An additional warning screen will appear when trying to disable this pack.

If you can't load a world after having disabled the Vanilla datapack, loading it in Safe Mode should be able to restore it.

0 comments on commit 51e17c8

Please sign in to comment.