Helpful comments (hopefully)

dhyces · Jun 1, 2024 · 8c7bcfc · 8c7bcfc
1 parent 4395c22
commit 8c7bcfc
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/common/src/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/material_suffixes.json b/common/src/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/material_suffixes.json
@@ -1,4 +1,5 @@
 {
+  "__comment": "This is a map which represents the actual texture locations and their corresponding generated texture suffix. It is highly recommended that mods prefix their suffixes with the modid, ie \"modid_adamantite\"",
   "values": {
     "minecraft:trims/color_palettes/quartz": "quartz",
     "minecraft:trims/color_palettes/iron": "iron",
@@ -11,6 +12,7 @@
     "minecraft:trims/color_palettes/lapis": "lapis",
     "minecraft:trims/color_palettes/amethyst": "amethyst"
   },
+  "__comment_2": "Use the darker map for any textures that are specialized for only certain cases",
   "append": [
     "trimmed:darker_material_suffixes"
   ]

diff --git a/...c/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/trim_material_overrides.json b/...c/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/trim_material_overrides.json
@@ -1,4 +1,5 @@
 {
+  "__comment": "This map represents a mapping of a trim color palette texture that does not appear well on the armor texture to another texture that should be used instead",
   "values": {},
   "append": [
     "trimmed:iron",

diff --git a/common/src/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/trim_overlays.json b/common/src/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/trim_overlays.json
@@ -1,4 +1,5 @@
 {
+  "__comment": "This map represents the armor item textures and their corresponding trim overlay textures. Used for model generators",
   "values": {},
   "append": [
     "trimmed:iron_armor",