From 8c7bcfc684ba2f187a6e79c7e9dc0153a2a30a89 Mon Sep 17 00:00:00 2001
From: dhyces <10985914+dhyces@users.noreply.github.com>
Date: Sat, 1 Jun 2024 15:14:15 -0700
Subject: [PATCH] Helpful comments (hopefully)

---
 .../trimmed/trimmed/maps/trimmed/texture/material_suffixes.json | 2 ++
 .../trimmed/maps/trimmed/texture/trim_material_overrides.json   | 1 +
 .../trimmed/trimmed/maps/trimmed/texture/trim_overlays.json     | 1 +
 3 files changed, 4 insertions(+)

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
index ae87ba54..a6309dba 100644
--- 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/common/src/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/trim_material_overrides.json b/common/src/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/trim_material_overrides.json
index 7d99f51c..4ba9b8c0 100644
--- a/common/src/main/resources/assets/trimmed/trimmed/maps/trimmed/texture/trim_material_overrides.json
+++ b/common/src/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
index 339b23dd..d42b0c75 100644
--- 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",