https://github.com/maael/ffxiv-overlays
⚔️ A collection of ACT overlays for FFXIV
https://github.com/maael/ffxiv-overlays
act dps-meter ffxiv ffxiv-overlays
Last synced: 12 months ago
JSON representation
⚔️ A collection of ACT overlays for FFXIV
- Host: GitHub
- URL: https://github.com/maael/ffxiv-overlays
- Owner: maael
- Created: 2019-07-23T10:27:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-01T13:01:27.000Z (about 2 years ago)
- Last Synced: 2025-04-18T09:34:34.791Z (about 1 year ago)
- Topics: act, dps-meter, ffxiv, ffxiv-overlays
- Language: JavaScript
- Homepage: https://maael.github.io/ffxiv-overlays/
- Size: 2.91 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FFXIV Overlays
A collection of ACT overlays for FFXIV.
## Usage
Put [https://maael.github.io/ffxiv-overlays/t/\](https://maael.github.io/ffxiv-overlays/t/) in your ACT.
## Themes
### [Base](https://maael.github.io/ffxiv-overlays/t/base)
Just a basic theme that logs out all the encounter data and first combatant data it gets from ACT events for debugging connection to ACT.
### [Mini DPS](https://maael.github.io/ffxiv-overlays/t/minidps)
Super minimal theme of player name, job, and damage.
> TODO: Add Image
## Development
1. `git clone git@github.com:maael/ffxiv-overlays.git`
2. `cd ffxiv-overlays`
3. `yarn`
4. `yarn dev`
5. Open browser to `http://localhost:3000`
6. Add `?simulator` as a query param to force themes to use simulated values
7. :sparkles:
## Deployment
Hosted on GitHub pages.
[https://maael.github.io/ffxiv-overlays](https://maael.github.io/ffxiv-overlays)
1. `yarn deploy`
2. `git push`
3. :sparkles:
## Notes
You can test themes by going to [https://maael.github.io/ffxiv-overlays/t/\](https://maael.github.io/ffxiv-overlays/t/) and adding query params such as:
- `simulator` - to enable a simulation of ACT
- `debug` - to log updates from the simulator to the console
## Ideas for themes
- Simple scrolling graph showing damage over fight for last X ticks, with current damage underneath it