From 3309386fbe2fdec69461f5fcec968aa7d5ac72fd Mon Sep 17 00:00:00 2001 From: Jon Kazama Date: Wed, 19 Aug 2026 22:52:19 +0200 Subject: [PATCH] docs(readme): the front page still described the plugin as it was at v1.1.0 It called the theme engine "a step toward a distinct UI look and feel", which was true when it was written and stopped being true somewhere around the fourth window rebuild. It also pointed new readers at `/hellionchat`, a command that does not exist -- the family is `/hellion` -- and put the wizard at three profiles when it has had four since May. The intro says what the plugin is now: a fork by origin, with everything above the message store rebuilt, and the differences from upstream named as features rather than as a rewrite plan. The paragraph no longer repeats what the upstream section further down already explains in more detail. Added the plugin notice the wizard shows every user. The repo front page is the other place someone lands first, and it was the only one of the two that said nothing. Counted the themes rather than trusting the number I was about to write: ten built-in palettes, not seven. Both remaining `/hellionchat` and "24 locales" mentions sit under headings that say "kept for context" and describe the state at that version. Those stay wrong on purpose. --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 08e3be4..24d7d19 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,14 @@ **Version 2.0.1** — Privacy-first chat plugin for FINAL FANTASY XIV / Dalamud, originally forked from [Chat 2](https://github.com/Infiziert90/ChatTwo) (EUPL-1.2). -Hellion Chat is a privacy-first plugin built on the Chat 2 foundation. The majority of the engine -comes from Chat 2 (message store, channel logic, hook system), and most keyboard shortcuts continue -to work as you'd expect. What changes: stricter privacy defaults out of the box, custom slash -commands under `/hellionchat`, no web interface, and as of v1.1.0, a theme engine as a step toward a -distinct UI look and feel. +Hellion Chat is a privacy-first chat plugin that began as a fork of Chat 2. The core it grew from +is still recognisable — the message store, the channel logic, the hook system — and most keyboard +shortcuts work the way you would expect. Everything above that has been rebuilt: as of v2.0.0 every +window is drawn by the plugin rather than by ImGui defaults. + +What sets it apart from upstream: stricter privacy defaults out of the box, a first-run wizard that +asks what may be stored before anything is, a theme engine with ten built-in palettes, 25 UI +languages, and no web interface. Slash commands live under `/hellion`. The data-handling focus is on GDPR/EU, US, and JP regulations, as far as practically applicable for a chat plugin: per-channel retention periods, granular filters, and self-service data export. A full @@ -31,6 +34,10 @@ fundamental rework and cherry-picks are no longer portable. From here, Hellion C independent codebase — background and attribution in [`docs/UPSTREAM_SYNC.md`](docs/UPSTREAM_SYNC.md). +> **A note on plugins.** Third-party plugins are a grey area in Final Fantasy XIV: Square Enix's +> terms of service do not cover them, and Naoki Yoshida has publicly asked that people not advertise +> them. Keep the subject out of Say, Yell, Shout and every other public channel in game. + ## Acknowledgements Hellion Chat is built on [Chat 2](https://github.com/Infiziert90/ChatTwo) by @@ -169,7 +176,7 @@ HellionChat/ │ ├── Inter-OFL.txt # OFL-1.1 license text (bundled with font) │ └── Language*.resx # Upstream localization (Crowdin) ├── Ui/ -│ ├── FirstRunWizard.cs # Three-profile onboarding +│ ├── FirstRunWizard.cs # Four-step, four-profile onboarding │ ├── StyleEngine/ # Tokens, widgets and the theme push │ ├── Windows/ # Main, settings, popouts, DB viewer │ └── Components/Settings/Tabs/