Skip to content

README.md

Latest commit

 

History

History
94 lines (80 loc) · 6.39 KB

README.md

File metadata and controls

94 lines (80 loc) · 6.39 KB

LOOKING FOR C# DEVELOPERS TO HELP MAINTAIN THIS - Please contact me if you're keen to get involved!

Chromatics Logo

Github All Releases Github Latest Releases Latest Release Discord

Join Support Discord
Documentation

Important: This is the Chromatics 4.x series. It is a complete rebuild of Chromatics from the ground up in .NET 10. It will utilise the new version of Sharlayan for async FFXIV calls and RGB.NET to standardise RGB device SDK's (as opposed to manually managing them as Chromatics 2.x did.

⚠️ Upgrading from Chromatics 3?

Chromatics 4 stores your settings in a new location on your computer, and your previous settings will not be carried across automatically. You can bring your layers and colour palette across manually using the steps below.

To bring your layer mappings across:

  1. Find your old layers.chromatics3 file. It will be in the same folder you had Chromatics 3 installed in.
  2. Open Chromatics 4 and go to the Mapping tab.
  3. Click Import and select your layers.chromatics3 file.

To bring your colour palette across:

  1. Find your old palette.chromatics3 file. It will be in the same folder you had Chromatics 3 installed in.
  2. Open Chromatics 4 and go to the Palette tab.
  3. Click Import and select your palette.chromatics3 file.

Your effects settings will need to be configured again from scratch. We apologise for the inconvenience — the rebuild was significant enough that a fully automatic migration was not possible.

Chromatics is a third-party add-on for Final Fantasy XIV which creates lighting effects on your RGB devices. There are many different scenes and effects available including:

  • HP/MP/GP/CP
  • Keybinds - lights your keys depending on your mapped keybind status
  • Castbar progress
  • Target HP/Target Castbar progress
  • Job Gauges
  • Enmity Tracker
  • Battle Stance
  • Reactive Weather - displays static & animation weather effects
  • Duty Finder Bell - flash your device when your DF pops
  • Damage Flash - flash your device when you take damage
  • Gold Saucer Vegas Mode
  • Title screen & cutscene animations

Chromatics Palettes



Chromatics is compatible with a wide range of RGB devices, supported by the library RGB.NET. Any devices supported by RGB.NET should be supported by Chromatics.

Developers

If you wish to build Chromatics yourself, you can download the active branch and open in Visual Studio 2022. Please pull all nuget packages and also link any additional libraries from Build Dependencies before building. If you need any further assistance, please contact us on Discord.

Open Source Libraries

  • RGB.NET - used for RGB device integration
  • Sharlayan - used for FFXIV memory reading
  • Artemis - borrowed some code base and RGB.NET profiles, not actually a dependency
  • FFXIVWeather - For calculating current weather.
  • Sentry - error monitoring, logs, metrics, tracing, and profiling

Privacy / Telemetry

Chromatics uses Sentry for two independent reporting paths: background telemetry (performance metrics, non-fatal errors) and crash reports (unhandled exceptions that terminate the app). They are controlled separately — opting out of telemetry does not disable the crash dialog, however crashes are never sent without you clicking on "Send", which is optional.

Background telemetry (toggleable):

  • Error-tier log lines only — other log types are kept local
  • Performance transactions and profiling samples
  • Anonymous session counts used to compute crash-free release-health statistics
  • Process metrics: working-set / private memory, managed heap size, CPU percent, GC counts, thread count, stamped on a 60-second heartbeat

Crash reports (always opt-in per event):

  • When Chromatics crashes, a dialog appears showing the error type, a Sentry reference id, and an optional free-text comment box
  • Nothing is sent until you click Send. Clicking Don't Send discards the report
  • The crash report contains the exception stack trace and the ~100 preceding log lines as breadcrumbs, plus the version/OS/runtime fields described above
  • Comments you type are sent as-is — do not include personal information

What we do NOT collect:

  • Your name, email, or any other personally identifying information — the crash dialog asks only for free-text comments
  • Your character name, server, free company, or any FFXIV account information
  • Your IP address
  • The contents of your screen, keystrokes, or any input
  • File paths or settings outside of what is directly relevant to a crash
  • Your bridge keys, light IDs, or any device credentials

Opting out of background telemetry: Toggle off at Settings → Advanced → Send anonymous performance and error telemetry. When disabled, Chromatics sends no performance data, session counts, or error messages — but the Sentry SDK remains loaded so the post-crash dialog can still give you the choice to send (or not send) a crash report on the rare occasion one occurs. If you also want to disable the crash dialog entirely, remove the Sentry package from a source build.



Disclaimer

Chromatics is not in anyway affiliated with Square Enix or FINAL FANTASY. All rights to their respected owners.

© 2010-2026 SQUARE ENIX CO., LTD. All Rights Reserved. A REALM REBORN is a registered trademark or trademark of Square Enix Co., Ltd. FINAL FANTASY, SQUARE ENIX and the SQUARE ENIX logo are registered trademarks or trademarks of Square Enix Holdings Co., Ltd.