Skip to content

Home

Jump to bottom
Nadya edited this page May 19, 2022 · 25 revisions

How Tidy Chat Works

Tidy Chat does not filter specific messages. Please repeat after me: Tidy Chat does not work by filtering specific messages. There are 12,000+ unique game messages and blocking them all individually is a fool's errand. Tidy Chat works by blocking all received messages and allowing specific messages through that match the whitelist filters.

If Tidy Chat is blocking a message you consider to be useful - please request for a filter to be added by opening a Github issue or submitting feedback. Including the exact message text is extremely helpful and will increase the likelihood of the filter being added quickly.

In addition, Tidy Chat works by checking received messages against dozens of handwritten Regex and Substring checks. Tidy Chat does not read from game data and in some cases even goes out of its way to avoid reading from game data. This is by design - to keep Tidy Chat "dumb enough" that anyone can maintain it in my absence and so that it should never break between patches or game updates. There are some downsides to this approach but I consider it a worthwhile tradeoff.

What Tidy Chat Won't Do

  • Block messages from other plugins. If you wish to toggle a particularly annoying or spammy plugin message off then please contact the developer in charge of the plugin and request they add a setting to toggle the message(s) off.
  • Block any messages from the Announcement channel or any of the Game Master channels.
  • Block arbitrary messages sent from other players or messages containing specific keywords. Use No Soliciting for such functionality. (Chat History is a bit of an exception to blocking messages from other players - as only repeated messages are blocked.)

FAQ

Read the Frequently Asked Questions.

Settings

Visit one of the following pages to see the filters for that tab explained

Localization

Tidy Chat is designed to work with each the Client's chat languages: Japanese, English, German, and French. While most filters have been localized to work for each language - 100% coverage has not been reached for every language. In addition, the in-game settings have yet to be translated. If you would like to help with the localization process and are fluent in Japanese, German, or French you can help by providing translations on Crowdin.

Clone this wiki locally