{"id":26851809,"url":"https://github.com/zeffuro/zeffui","last_synced_at":"2025-04-08T03:17:04.342Z","repository":{"id":38019011,"uuid":"237852478","full_name":"Zeffuro/ZeffUI","owner":"Zeffuro","description":"A FFXIV Overlay for OverlayPlugin using HTML and JS","archived":false,"fork":false,"pushed_at":"2025-01-18T16:19:48.000Z","size":6599,"stargazers_count":72,"open_issues_count":16,"forks_count":22,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T22:35:58.662Z","etag":null,"topics":["act","buffs","fantasy","ffxiv-overlay","ffxiv-plugin","final","overlayplugin","zeffui"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zeffuro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"zeffuro","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-02-02T23:28:20.000Z","updated_at":"2025-02-09T18:46:09.000Z","dependencies_parsed_at":"2024-06-25T18:12:55.216Z","dependency_job_id":"9e1de275-59d0-4eff-a59b-34d435651143","html_url":"https://github.com/Zeffuro/ZeffUI","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeffuro%2FZeffUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeffuro%2FZeffUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeffuro%2FZeffUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zeffuro%2FZeffUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zeffuro","download_url":"https://codeload.github.com/Zeffuro/ZeffUI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247767237,"owners_count":20992548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["act","buffs","fantasy","ffxiv-overlay","ffxiv-plugin","final","overlayplugin","zeffui"],"created_at":"2025-03-30T22:36:12.003Z","updated_at":"2025-04-08T03:17:04.317Z","avatar_url":"https://github.com/Zeffuro.png","language":"JavaScript","funding_links":["https://ko-fi.com/zeffuro"],"categories":[],"sub_categories":[],"readme":"# ZeffUI\n\nA FFXIV Overlay for OverlayPlugin using HTML and JS\n\n1. [About](#about)\n1. [Installing](#installing)\n1. [Customization](#customization)\n1. [Contacting](#contacting)\n\n## About\n\nZeffUI 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)\nwhich are plugins for\n[Advanced Combat Tracker](http://advancedcombattracker.com/).\n\nZeffUI is currently pretty customizeable and I'm hoping it's only going to get better!\n\n![customization screenshot](screenshots/customization.png)\n\n![settings screenshot](screenshots/settings.png)\n\nZeffUI currently has these modules built in:\n\n-   Health and Manabars\n\n![healthmana screenshot](screenshots/healthmana.png)\n\n-   MP Ticker\n\n![mpticker gif](screenshots/mpticker.gif)\n\n-   Pulltimer\n\n![pulltimer screenshot](screenshots/pulltimer.png)\n\n-   DoT Timers\n\n![dotbars screenshot](screenshots/dotbars.png)\n\n-   Buff Timers\n\n![buffbars screenshot](screenshots/buffbars.png)\n\n-   Raidbuff Cooldowns\n\n![raidbuffs screenshot](screenshots/raidbuffs.png)\n\n-   Mitigation Cooldowns for Tanks\n\n![mitigation screenshot](screenshots/mitigation.png)\n\n-   Party Cooldowns\n\n![partycooldowns screenshot](screenshots/partycooldowns.png)\n\n-   Custom Cooldowns\n\n![customcooldowns gif](screenshots/customcd.gif)\n\n-   Stacks for certain classes (like Ruin IV stacks for SMN)\n\n![stacks screenshot](screenshots/stacks.png)\n\n## Installing\n\n### Dependencies\n\nInstall [.NET Framework](https://www.microsoft.com/net/download/framework) version 4.6.1 or above.\n\nYou must have [DirectX 11](http://imgur.com/TjcnjmG) enabled for Final Fantasy XIV.\n\nInstall the 64-bit version of [Advanced Combat Tracker](http://advancedcombattracker.com/), if you have not already.\n\n### Install FFXIV ACT Plugin\n\nIf you have just installed ACT,\nthen you will be presented with a startup wizard.\nTo get to the startup wizard otherwise,\nclick on `Options` and then click on `Show Startup Wizard`.\n\n![startup wizard screenshot](screenshots/ffxiv_plugin_show_startup_wizard.png)\n\nIn the startup wizard,\nselect `FFXIV Parsing Plugin` and then click the `Download/Enable Plugin` button.\nThis will download `%APPDATA%Advanced Combat Tracker\\Plugins\\FFXIV_ACT_Plugin.dll`\nand enable it in the list of plugins.\n\n![startup wizard download screenshot](screenshots/ffxiv_plugin_parsing_plugin.png)\n\nAdditionally, you must enable parsing from the network and make sure that ACT is not firewalled.\nMake sure the settings for the FFXIV plugin have the \"Include HP for Triggers\" button checked.\nThis is under `Plugins` -\u003e`FFXIV Settings` -\u003e `Options`.\n\nAlternative FFXIV Plugin Guides:\n\n-   [fflogs video guide](https://www.fflogs.com/help/start/)\n-   [TomRichter guide](https://gist.github.com/TomRichter/e044a3dff5c50024cf514ffb20a201a9#installing-act--ffxiv-plugin)\n\n### Install ngld OverlayPlugin\n\nAt this point, if you select the `Plugins` tab and go to the `Plugin Listing`,\nyour list of plugins should look something like this:\n\n![blank plugin listing screenshot](screenshots/get_plugins_blank.png)\n\nClick on `Get Plugins` to open up the ACT plugin installer.\n\nSelect `Overlay Plugin` and then click `Download and Enable`.\n\n![overlay plugin selection screenshot](screenshots/get_plugins_overlayplugin.png)\n\nThis will download the ngld OverlayPlugin into\n`%APPDATA%Advanced Combat Tracker\\Plugins\\OverlayPlugin`\nand enable `OverlayPlugin.dll` in the list of plugins.\n\nAs a note, you must use the [ngld](https://github.com/ngld) version of\nOverlayPlugin and not the original RainbowMage version or the hibiyasleep fork.\n\n### Installing cactbot\n\nAgain, go to the `Plugins` tab and go to the `Plugin Listing`,\nand then select `Get Plugins`.\n\nSelect `Cactbot` and then click `Download and Enable`.\n\n![cactbot selection screenshot](screenshots/get_plugins_cactbot.png)\n\nThis will download the cactbot into\n`%APPDATA%Advanced Combat Tracker\\Plugins\\cactbot-version\\cactbot`\nand enable `CactbotOverlay.dll` in the list of plugins.\n\n**Note**: Due to a difference in how ACT expects archives to be\nand how cactbot generates its zip files,\nthere will be something like a `cactbot-0.15.2` folder\nthat corresponds to the initial version that you downloaded cactbot.\nThis folder name does not matter and is cosmetic.\n\nVerify your plugins are in the correct order.\nThe order should be: FFXIV Plugin first, then OverlayPlugin, then cactbot.\nIf you have followed the above instructions, it should look like the following:\n\n![plugin order](screenshots/get_plugins_complete.png)\n\nFinally, restart ACT.\n\n## Adding ZeffUI Overlay\n\nHere's how you finally add ZeffUI\n\n1.  Open ACT.\n1.  Make sure you've restarted ACT after adding the cactbot plugin.\n1.  Navigate to the `Plugins` tab of ACT and then the `OverlayPlugin.dll` tab inside it.\n1.  Click the \"New\" button and then pick `ZeffUI` in the Preset list.\n\n    ![new overlay plugin screenshot](screenshots/overlay_plugin_new.png)\n\n1.  At this point you'll see health and manabars\n    and a blue background to help with resizing and placing overlays on screen.\n    The blue background will go away when the overlay is locked in the config panel for the overlay.\n    You should always lock your overlay once you are done resizing and placing it.\n\n        ![zeffui plugin unlocked](screenshots/overlay_plugin_new_zeffui_unlocked.png)\n\n1.  Type in any name you'd like as the name of this overlay, e.g. `ZeffUI`.\n1.  Click the `OK` button to add this as an Overlay.\n    It will now appear in the list of overlays in the `Plugins` -\u003e `OverlayPlugin.dll` tab.\n\n1.  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/\n\n1.  Drag and resize the overlay to the location that you want it in.\n\n1.  In the `General` tab of the `ZeffUI` overlay, click the `Lock Overlay` checkbox.\n    The blue background will disappear once the overlay has been locked.\n\n1.  Rightclick either the Healthbar or Manabar element.\n\n    ![zeffui plugin unlock bars](screenshots/zeffui_unlock_bars.png)\n\n1.  If you want you can also toggle the grid to give you an easier time aligning objects.\n\n1.  Start moving elements to where you want, note that the anchors for Raidbuffs and Mitigation will only show up on the appropriate classes.\n\n    ![zeffui plugin move elements](screenshots/zeffui_move_elements.png)\n\n1.  After that either lock the bars again or head over to settings to customize your setup.\n\n    ![zeffui plugin unlock bars](screenshots/zeffui_unlock_bars.png)\n\n1.  After that your setup should be complete.\n\nIf you need any help either raise an issue or find me on the ACT/Triggernometry Discord servers or DM me directly on Zeffuro#3033\n\n## Customization\n\nYou can customize ZeffUI further by using custom CSS and text format tags\n\n![image](https://user-images.githubusercontent.com/4972345/130093739-9993b2a6-33a9-4964-8a5e-6034775c23fc.png)\n\n[Custom CSS Examples](CUSTOMCSS.md)\n\n[Text Format List](TEXTFORMAT.md)\n\n[UI Exports](UIEXPORTS.md)\n\n## Contacting\n\nIf 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)\n\n## Licensing, Trademarks, Copyright\n\nZeffUI is open source under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE).\n\nFINAL FANTASY is a registered trademark of Square Enix Holdings Co., Ltd.\n\nFinal Fantasy art and icons reused non-commercially under the\n[FINAL FANTASY® XIV Materials Usage License](https://support.na.square-enix.com/rule.php?id=5382).\n\nSee the [LICENSE](LICENSE) file for more details about other bundled projects.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeffuro%2Fzeffui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeffuro%2Fzeffui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeffuro%2Fzeffui/lists"}