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/