Skip to content

Commit

Permalink
Added a configuration option table
Browse files Browse the repository at this point in the history
  • Loading branch information
mrbuilder1961 authored Mar 19, 2022
1 parent ed604e8 commit 87beb74
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

This mod does quite a few things:
- Increases the maximum amount of chat based on allocated RAM (minimally it goes from 100 -> 1024 max messages)
- Adds a timestamp in front of all messages, formatted like [HOUR:MINUTE:SECOND] in pink text, with a tooltip that renders a complete date down to the millisecond
- Adds a timestamp in front of all messages, formatted like `[HOUR:MINUTE:SECOND]` in pink text, with a tooltip that renders a complete date down to the millisecond
- Keeps chat history and previously sent messages across ALL world/servers (but automatically resets on game exit)
- All of this is configurable

Expand All @@ -20,6 +20,24 @@ Be on the lookout for new versions, issues, and possible future features!

If that doesn't work, then I don't know, just trial-and-error things? Do whatever you'd normally do? I honestly don't know.

## Configuration help

| Name | Default Value | Description | Example | Lang Key |
|---|---|---|---|---|
| Timestamp toggle | `true` | Should the timestamp in front of all messages show? | `false` | text.wmch.time |
| Timestamp text | `"[HH:mm:ss]"` | The text that is used for the timestamp. To add time values, see [https://i.imgur.com/KlBIDWf.png]. | `"'TIME'- HH:mm"` | text.wmch.timeStr |
| Timestamp color | `0xFF55FF` (`16733695`) | The color that is applied BEFORE the timestamp modifiers, while also overriding any colors provided there. | `10743823` | text.wmch.timeColor |
| Timestamp modifiers | `[]` | The array of Formattings to modify the looks of the timestamp's text. See the name values at [https://minecraft.fandom.com/wiki/Formatting_codes]. | `["obfuscated"]` | text.wmch.timeFormatting |
| Hover toggle | `true` | Should the text that appears when you hover over the timestamp show? | `false` | text.wmch.hover |
| Hover text | `"yyyy dd, MM, @ HH:mm:ss.SSSS"` | The text that shows when you hover over the timestamp in front of all chat messages. For dynamic text, see [https://i.imgur.com/KlBIDWf.png]. | `"MM/DD/YYYY"` | text.wmch.hoverStr |
| Boundary toggle | `true` | Should a boundary line show after using chat and leaving then joining again later? | `false` | text.wmch.boundary |
| Boundary text | `"<]===---{ SESSION BOUNDARY LINE }---===[>"` | The text that is shown when a boundary line is inserted into the chat. | `"world/session barrier"` | text.wmch.boundaryStr |
| Boundary color | `0x00AAAA` (`43690`) | The color that is applied BEFORE the boundary modifiers, while also overriding any colors provided there. | `15732643` | text.wmch.boundaryColor |
| Boundary modifiers | `[]` | The array of Formattings to modify the looks of the boundary text. Ignores color values (Boundary color). See the name values at [https://minecraft.fandom.com/wiki/Formatting_codes]. | `["bold", "underline"]` | text.wmch.boundaryFormatting |
| Playername text | `"<$>"` | The text that replaces the playername in most references (if present). No brackets would be $; as $ represents the playername. Only for player messages. | `"[$]"` | text.wmch.nameStr |
| Maximum chat messages | `1024` | The max amount of chat messages allowed to render. Not recommended to change, as it's automatically adjusted based on RAM allocation. | `5237` | text.wmch.maxMsgs |
| Reset all settings | `false` | If this is toggled on, it will reset ALL options to their default values. | `true` | text.wmch.reset |

## Possible features

- Make certain messages automatically copiable, such as the Open-To-LAN port
Expand All @@ -31,7 +49,7 @@ If that doesn't work, then I don't know, just trial-and-error things? Do whateve

## Changelog

See individual releases for specific changelogs, a full one may be made at some point.
See [individual releases](https://github.com/mrbuilder1961/WheresMyChatHistory/releases) for specific changelogs or the [commit list](https://github.com/mrbuilder1961/WheresMyChatHistory/commits/1.18.x). A complete one may be made at some point.

## Wont fix/add

Expand Down

0 comments on commit 87beb74

Please sign in to comment.