THE CODEX OVERLAY  v1.5.2
A live combat overlay for Celtic Heroes  -  https://the-codex.ch/overlay

WHAT IT DOES
- Your debuffs and DoTs on your target, with timers. Warns you when someone
  overcasts yours with a weaker one, and when one is about to run out.
- Debuffs you choose to watch (Hellgod's Sundering, Debilitating Chill, ...) on your
  target, whoever cast them, so you can time your own. Set per character.
- Your own buffs (Steady Aim, Sharpen Weapons, Attunements, ...) as big countdowns.
- A READY light for the cooldowns you pick, per character.
- A clean damage feed and a DPS meter for the mob you're fighting.
- Hover over the target's HP bar for its live resists and debuffs.
- A kill summary after every fight: DPS, damage per skill, hits, crits,
  and how far your group lowered each resist.

HOW TO START
1. Unzip this folder anywhere (for example your Documents).
2. Double-click CodexOverlay.exe. The Codex Overlay app opens.
   - Windows may say "Windows protected your PC": click "More info", then "Run anyway".
3. Click "Start overlay". Click "Yes" on the admin prompt: reading game traffic needs
   admin rights. If the Windows Firewall asks, click "Allow".
4. Start Celtic Heroes in your emulator (LDPlayer, BlueStacks, MuMu, Nox, MEmu)
   or the PC client (Steam). The overlay sits on top of the game window.
5. Hover the Codex button for the menu: recent fights and settings.
   Closing the app while the overlay runs tucks it away: double-click the Codex icon
   in the tray (or use the Codex menu in game) to open it again.

CUSTOMIZE
In the app, open Customize in the sidebar (fold the sidebar to icons with the arrow at
the top) and pick a panel. Customize shows every panel on a preview of the game: drag them, resize
them (drag the corner of the outlined panel), hide them, and let a panel grow upward
so it lines up with the mob's HP bar. Changes show in the running overlay straight away.
Pick a character at the top: its buffs, debuffs and cooldowns are its own, and the
preview shows exactly what that character gets. Each one has its own sound: none, a
beep when it runs out (or a cooldown is ready), a warning in the last 5 seconds, or both.
Your own debuffs show up by themselves once you've used them; remove any you don't want.
Your characters show up once the overlay has seen each of them log in (or go to
character select and back in).

If a notice says "Use a skill once" or "No mob data found", do just that
(or relog / switch areas) and it goes away by itself.

Tip: in Settings, "Start without the Windows prompt" skips the admin prompt from then on.
Settings also has the theme, sound and volume (with a Test button), and the overlay's files.

FIGHT HISTORY
Open Fight history in the app (or double-click "Fight history") to browse every saved
fight, no game needed: search by name or mob, show only bosses by power rating (the
stars on a mob's HP bar), sort by any column, give a fight its own name, delete one, or
open its card (the expand button) to save or copy it as a picture.

PRESETS (EXPERIMENTAL, LDPLAYER 9 ONLY, USE AT YOUR OWN RISK)
Save a character's gear and hotbar as a preset and switch to it with one click.
Unlike the rest of the overlay, Presets changes your character: it calls into the
game inside LDPlayer. Open Presets in the app; the first time it shows the setup:
1. Install 64-bit Python 3 from python.org, tick "Add python.exe to PATH".
2. In LDPlayer 9: Settings > Other settings > ROOT permission > Enable, restart LDPlayer.
3. Open LDPlayer, then click Install (downloads Frida, about 100 MB).
Then log in and click New preset. Works with Celtic Heroes 6.16.0 only. Stay out of
combat and close game menus while applying, and check your gear afterwards.

UPDATES
When a new version is out, the app shows an Update button. Press it: it downloads
the new version, checks it and restarts by itself.

IS IT SAFE?
The overlay only listens to the game's network traffic on your own PC.
It never changes the game, never sends anything, and needs no account details.
The one exception is Presets, which you set up yourself: Apply changes your gear and hotbar.
At start it asks the-codex.ch whether there's a newer version (nothing about you is sent).
It is a third-party tool: use it at your own risk under the game's terms.

FEATURE REQUESTS AND BUGS
Find TechNick (@Nickaww) in the official Celtic Heroes Discord: https://discord.gg/F82NbGrK7U

UNINSTALL
Turn "Start the overlay without the Windows admin prompt" off in Settings (if you turned it on), then delete this folder.

CREDITS
Font: Brawler (SIL Open Font License 1.1, see OFL-Brawler.txt).
Mob base stats: the Masters Grimoire database.
Not affiliated with the developers of Celtic Heroes.
