Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisFeline committed Oct 5, 2024
1 parent 5fea843 commit eadfc5c
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
40 changes: 38 additions & 2 deletions Docs/OSC/OSC_Parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions Localization/Language/en-US.json
Original file line number Diff line number Diff line change
Expand Up @@ -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}",
Expand Down
1 change: 1 addition & 0 deletions Windows/EditWindow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit eadfc5c

Please sign in to comment.