aboutsummaryrefslogtreecommitdiff
path: root/src/main/resources/assets/skyblocker/tabhud/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/resources/assets/skyblocker/tabhud/readme.md')
-rw-r--r--src/main/resources/assets/skyblocker/tabhud/readme.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/main/resources/assets/skyblocker/tabhud/readme.md b/src/main/resources/assets/skyblocker/tabhud/readme.md
index 800a69d2..a50c1f96 100644
--- a/src/main/resources/assets/skyblocker/tabhud/readme.md
+++ b/src/main/resources/assets/skyblocker/tabhud/readme.md
@@ -6,12 +6,15 @@ my_pack
└───assets
└───skyblocker
└───tabhud
+ ├───version.json
├───screen_a
├───screen_b
└───standard
```
The three dirs `screen_a`, `screen_b` and `standard` contain the screen definition JSON files as described below. `standard` describes the screens shown when just the TAB key is pressed, while `screen_a/b` describe the screens shown when using the modifier keys A and B (default binds: N and B).
The file names are used to describe where a screen is shown. They are case sensitive. For a full list of possible names see Appendix A. While this scheme necessitates duplicate file contents and results in similar file names in different directories, it also allows for much control both when creating a complete layout or when only overriding specific screens.
+The `version.json` file contains a single line `{ "version": X }`, where X is the version of the internal resource pack format. This number is incremented when major changes to the resource pack structure are made in the future. It's currently 1; packs with a different version number are rejected.
+IF A MAJOR CHANGE IS MADE THAT MODIFIES THE VERSION NUMBER AND THEREFORE BREAKS YOUR LAYOUT, EDITING THE VERSION FILE WITHOUT REMAKING THE RESOURCE PACK DOES NOT FIX ANYTHING.
# Screen definition JSONs
This file consists of one widgets section and one layout section.