https://github.com/zeffuro/zeffui

A FFXIV Overlay for OverlayPlugin using HTML and JS
https://github.com/zeffuro/zeffui

act buffs fantasy ffxiv-overlay ffxiv-plugin final overlayplugin zeffui

Last synced: 2 months ago
JSON representation

A FFXIV Overlay for OverlayPlugin using HTML and JS

• Host: GitHub
• URL: https://github.com/zeffuro/zeffui
• Owner: Zeffuro
• License: agpl-3.0
• Created: 2020-02-02T23:28:20.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-18T16:19:48.000Z (5 months ago)
• Last Synced: 2025-03-30T22:35:58.662Z (3 months ago)
• Topics: act, buffs, fantasy, ffxiv-overlay, ffxiv-plugin, final, overlayplugin, zeffui
• Language: JavaScript
• Homepage:
• Size: 6.29 MB
• Stars: 72
• Watchers: 3
• Forks: 22
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# ZeffUI

A FFXIV Overlay for OverlayPlugin using HTML and JS

1. [About](#about)

1. [Installing](#installing)

1. [Customization](#customization)

1. [Contacting](#contacting)

## About

ZeffUI is an ACT overlay that provides for [Final Fantasy XIV](http://www.finalfantasyxiv.com/). This project uses [cactbot](https://github.com/quisquous/cactbot/) and [ngld's OverlayPlugin](https://github.com/ngld/OverlayPlugin)

which are plugins for

[Advanced Combat Tracker](http://advancedcombattracker.com/).

ZeffUI is currently pretty customizeable and I'm hoping it's only going to get better!

![customization screenshot](screenshots/customization.png)

![settings screenshot](screenshots/settings.png)

ZeffUI currently has these modules built in:

-   Health and Manabars

![healthmana screenshot](screenshots/healthmana.png)

-   MP Ticker

![mpticker gif](screenshots/mpticker.gif)

-   Pulltimer

![pulltimer screenshot](screenshots/pulltimer.png)

-   DoT Timers

![dotbars screenshot](screenshots/dotbars.png)

-   Buff Timers

![buffbars screenshot](screenshots/buffbars.png)

-   Raidbuff Cooldowns

![raidbuffs screenshot](screenshots/raidbuffs.png)

-   Mitigation Cooldowns for Tanks

![mitigation screenshot](screenshots/mitigation.png)

-   Party Cooldowns

![partycooldowns screenshot](screenshots/partycooldowns.png)

-   Custom Cooldowns

![customcooldowns gif](screenshots/customcd.gif)

-   Stacks for certain classes (like Ruin IV stacks for SMN)

![stacks screenshot](screenshots/stacks.png)

## Installing

### Dependencies

Install [.NET Framework](https://www.microsoft.com/net/download/framework) version 4.6.1 or above.

You must have [DirectX 11](http://imgur.com/TjcnjmG) enabled for Final Fantasy XIV.

Install the 64-bit version of [Advanced Combat Tracker](http://advancedcombattracker.com/), if you have not already.

### Install FFXIV ACT Plugin

If you have just installed ACT,

then you will be presented with a startup wizard.

To get to the startup wizard otherwise,

click on `Options` and then click on `Show Startup Wizard`.

![startup wizard screenshot](screenshots/ffxiv_plugin_show_startup_wizard.png)

In the startup wizard,

select `FFXIV Parsing Plugin` and then click the `Download/Enable Plugin` button.

This will download `%APPDATA%Advanced Combat Tracker\Plugins\FFXIV_ACT_Plugin.dll`

and enable it in the list of plugins.

![startup wizard download screenshot](screenshots/ffxiv_plugin_parsing_plugin.png)

Additionally, you must enable parsing from the network and make sure that ACT is not firewalled.

Make sure the settings for the FFXIV plugin have the "Include HP for Triggers" button checked.

This is under `Plugins` ->`FFXIV Settings` -> `Options`.

Alternative FFXIV Plugin Guides:

-   [fflogs video guide](https://www.fflogs.com/help/start/)

-   [TomRichter guide](https://gist.github.com/TomRichter/e044a3dff5c50024cf514ffb20a201a9#installing-act--ffxiv-plugin)

### Install ngld OverlayPlugin

At this point, if you select the `Plugins` tab and go to the `Plugin Listing`,

your list of plugins should look something like this:

![blank plugin listing screenshot](screenshots/get_plugins_blank.png)

Click on `Get Plugins` to open up the ACT plugin installer.

Select `Overlay Plugin` and then click `Download and Enable`.

![overlay plugin selection screenshot](screenshots/get_plugins_overlayplugin.png)

This will download the ngld OverlayPlugin into

`%APPDATA%Advanced Combat Tracker\Plugins\OverlayPlugin`

and enable `OverlayPlugin.dll` in the list of plugins.

As a note, you must use the [ngld](https://github.com/ngld) version of

OverlayPlugin and not the original RainbowMage version or the hibiyasleep fork.

### Installing cactbot

Again, go to the `Plugins` tab and go to the `Plugin Listing`,

and then select `Get Plugins`.

Select `Cactbot` and then click `Download and Enable`.

![cactbot selection screenshot](screenshots/get_plugins_cactbot.png)

This will download the cactbot into

`%APPDATA%Advanced Combat Tracker\Plugins\cactbot-version\cactbot`

and enable `CactbotOverlay.dll` in the list of plugins.

**Note**: Due to a difference in how ACT expects archives to be

and how cactbot generates its zip files,

there will be something like a `cactbot-0.15.2` folder

that corresponds to the initial version that you downloaded cactbot.

This folder name does not matter and is cosmetic.

Verify your plugins are in the correct order.

The order should be: FFXIV Plugin first, then OverlayPlugin, then cactbot.

If you have followed the above instructions, it should look like the following:

![plugin order](screenshots/get_plugins_complete.png)

Finally, restart ACT.

## Adding ZeffUI Overlay

Here's how you finally add ZeffUI

1.  Open ACT.

1.  Make sure you've restarted ACT after adding the cactbot plugin.

1.  Navigate to the `Plugins` tab of ACT and then the `OverlayPlugin.dll` tab inside it.

1.  Click the "New" button and then pick `ZeffUI` in the Preset list.

    ![new overlay plugin screenshot](screenshots/overlay_plugin_new.png)

1.  At this point you'll see health and manabars

    and a blue background to help with resizing and placing overlays on screen.

    The blue background will go away when the overlay is locked in the config panel for the overlay.

    You should always lock your overlay once you are done resizing and placing it.

        ![zeffui plugin unlocked](screenshots/overlay_plugin_new_zeffui_unlocked.png)

1.  Type in any name you'd like as the name of this overlay, e.g. `ZeffUI`.

1.  Click the `OK` button to add this as an Overlay.

    It will now appear in the list of overlays in the `Plugins` -> `OverlayPlugin.dll` tab.

1.  If for some reason the UI doesn't show up confirm that the following URL is populating the URL field: https://zeffuro.github.io/ZeffUI/

1.  Drag and resize the overlay to the location that you want it in.

1.  In the `General` tab of the `ZeffUI` overlay, click the `Lock Overlay` checkbox.

    The blue background will disappear once the overlay has been locked.

1.  Rightclick either the Healthbar or Manabar element.

    ![zeffui plugin unlock bars](screenshots/zeffui_unlock_bars.png)

1.  If you want you can also toggle the grid to give you an easier time aligning objects.

1.  Start moving elements to where you want, note that the anchors for Raidbuffs and Mitigation will only show up on the appropriate classes.

    ![zeffui plugin move elements](screenshots/zeffui_move_elements.png)

1.  After that either lock the bars again or head over to settings to customize your setup.

    ![zeffui plugin unlock bars](screenshots/zeffui_unlock_bars.png)

1.  After that your setup should be complete.

If you need any help either raise an issue or find me on the ACT/Triggernometry Discord servers or DM me directly on Zeffuro#3033

## Customization

You can customize ZeffUI further by using custom CSS and text format tags

![image](https://user-images.githubusercontent.com/4972345/130093739-9993b2a6-33a9-4964-8a5e-6034775c23fc.png)

[Custom CSS Examples](CUSTOMCSS.md)

[Text Format List](TEXTFORMAT.md)

[UI Exports](UIEXPORTS.md)

## Contacting

If you need any help either raise an issue or join the [DelvUI Discord](https://discord.gg/xzde5qQayh) (or find me on ACT/Triggernometry/goat Discord or DM me Zeffuro#3033)

## Licensing, Trademarks, Copyright

ZeffUI is open source under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE).

FINAL FANTASY is a registered trademark of Square Enix Holdings Co., Ltd.

Final Fantasy art and icons reused non-commercially under the

[FINAL FANTASY® XIV Materials Usage License](https://support.na.square-enix.com/rule.php?id=5382).

See the [LICENSE](LICENSE) file for more details about other bundled projects.