From eadfc5cb29cfc2c364587d85cee516f916dc6a64 Mon Sep 17 00:00:00 2001
From: Kittenji <41535779+ChrisFeline@users.noreply.github.com>
Date: Sat, 5 Oct 2024 18:54:59 -0400
Subject: [PATCH] Update Documentation

---
 CHANGELOG.md                     |  1 +
 Docs/OSC/OSC_Parameters.md       | 40 ++++++++++++++++++++++++++++++--
 Localization/Language/en-US.json |  1 +
 Windows/EditWindow.cs            |  1 +
 4 files changed, 41 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 897e45e..14db947 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 - Added Rich Presence PartyID, when you are in a VC it will collapse into a single presence when playing on the same lobby.
 - Rich Presence now dissapears when you are not in the ToN world.
+- Added a button to switch format for OSC colors from HSV to RGB.
 - Fixed Web Tracker Compatibility toggle sometimes showing up when Web Socket Server option was disabled.
 - Updated Japanese localization. (Thank you @nomlasvrc)
 - Updated Traditional Chinese localization. (Thank you @XoF-eLtTiL)
\ No newline at end of file
diff --git a/Docs/OSC/OSC_Parameters.md b/Docs/OSC/OSC_Parameters.md
index 8e0c71d..d99ba62 100644
--- a/Docs/OSC/OSC_Parameters.md
+++ b/Docs/OSC/OSC_Parameters.md
@@ -17,21 +17,57 @@ Parameter        | Type    | Description
 `ToN_Saboteur`   | `BOOL`  | The player is the killer on a Sabotage round.
 
 # Terrors
+### Terrors in Round
+> These values represent the current index or id of the terror in the current round.<br>
+> Since these ID's are index based, the value will be **255** when no terror has spawned.<br>
+
 Parameter        | Type    | Description
 -----------------|---------|--------------------------
 `ToN_Terror1`    | `INT`   | The current terror index.
 `ToN_Terror2`    | `INT`   | The second terror index. (Bloodbath & Midnight)
-`ToN_Terror3`    | `INT`   | The third terror index. (Bloodbath & Alternate on Midnight)
+`ToN_Terror3`    | `INT`   | The third terror index. (Bloodbath & Midnight)<br>This last one will be an Alternate ID on Midnight.
+
+> Please note that there's some special cases where these values change a bit.
+> **Monarch** will use the `Terror3` as identifier and `Terror1` and `Terror2` will be set to **255**.
+
+> **8 PAGES** uses these parameters a bit differently.<br>
+> - `Terror1` is the normalized terror ID, meaning it will use the index from the corresponding group.
+> - `Terror2` is the group that the `Terror1` belongs to.
+>	* `0` - is **Classic**
+>	* `1` - is **Alternate**
+>	* `2` - is **8 Pages** Original
+> - `Terror3` would be the actual index on the **8 PAGES** pool.
+
+### Terrors phase index.
+> These values represent the different phases of some terrors.<br>
+> For example: **Faker** or **Bliss**.
+
+Parameter        | Type    | Description
+-----------------|---------|--------------------------
 `ToN_TPhase1`    | `INT`   | The current terror phase.
 `ToN_TPhase2`    | `INT`   | The second terror phase. (Bloodbath)
 `ToN_TPhase3`    | `INT`   | The third terror phase. (Bloodbath & Midnight)
 
 # Colors
+### HSV - HSL Format (Default)
+> If the format is set to **HSV**, these parameters will be sent to **OSC**.<br>
+> In **HSL** format, `ToN_ColorV` will change to `ToN_ColorL` instead.
+
 Parameter        | Type    | Description
 -----------------|---------|--------------------------
 `ToN_ColorH`     | `FLOAT` | HUD Terror Color (HUE)
 `ToN_ColorS`     | `FLOAT` | HUD Terror Color (Saturation)
-`ToN_ColorV`     | `FLOAT` | HUD Terror Color (Value)
+`ToN_ColorV`<br>`ToN_ColorL`     | `FLOAT` | HUD Terror Color (Value)<br>(Lightness) If format is **HSL**.
+
+### RGB - RGB32 Format
+> If the format is set to **RGB**, these parameters will be sent instead of **HSV**.<br>
+> In **RGB32** format, these values will be sent as an **Int** (Range 0-255) instead of a **Float**.
+
+Parameter        | Type    | Description
+-----------------|---------|--------------------------
+`ToN_ColorR`     | `FLOAT` | HUD Terror Color RED
+`ToN_ColorG`     | `FLOAT` | HUD Terror Color GREEN
+`ToN_ColorB`     | `FLOAT` | HUD Terror Color BLUE
 
 # Encounters
 Parameter          | Type    | Description
diff --git a/Localization/Language/en-US.json b/Localization/Language/en-US.json
index 7ee1bc4..837dab9 100644
--- a/Localization/Language/en-US.json
+++ b/Localization/Language/en-US.json
@@ -6,6 +6,7 @@
 	"EDIT.DELETE": "Delete",
 	"EDIT.OK": "OK",
 	"EDIT.CANCEL": "Cancel",
+	"EDIT.INSERT_TEMPLATE": "Insert Template Key",
 
 	"MESSAGE.WRITE_SETTINGS_ERROR": "An error ocurred while trying to write your settings to a file.\n\nMake sure that the program contains permissions to write files in the current folder it's located at.",
 	"MESSAGE.COPY_FILES_ERROR": "An error ocurred while trying to copy your files to the selected location.\n\nMake sure that the program contains permissions to write files to the destination.\nPath: {0}",
diff --git a/Windows/EditWindow.cs b/Windows/EditWindow.cs
index 2f6ca01..679cac7 100644
--- a/Windows/EditWindow.cs
+++ b/Windows/EditWindow.cs
@@ -77,6 +77,7 @@ private void EditWindow_Shown(object sender, EventArgs e) {
         internal void LocalizeContent() {
             button1.Text = LANG.S("EDIT.SAVE") ?? "Save";
             button2.Text = LANG.S("EDIT.CANCEL") ?? "Cancel";
+            buttonInsert.Text = LANG.S("EDIT.INSERT_TEMPLATE") ?? "Insert Template Key";
         }
 
         private bool IsEmpty;