SezzUI for Final Fantasy XIV
Minimalistic UI Additions & Tweaks
Explore the docs »
(Spoiler alert: There is no documentation!)
Report Bug
·
Request Feature
Table of Contents
About The Project
This is aimed to be a port of my World of Wacraft UI that I've been using since 2008, you can find that one at https://github.com/mkarer/ElvUI_SezzUI soon™ (aka whenever I find time to clean up the code).
SezzUI won't give you any unfair advantages. Neither does it automate the game without direct interaction, nor will it ever do. Everything this plugin offers is either a clientside UI improvement or can be already achieved by the default client (just not that convenient).
WARNING: At the current state of the plugin I would strongly advice against using it.
While it should be stable I cannot guarantee that it won't crash. I'm using this project to get into C#, which means major changes and rewrites are expected to happen every now and then as I learn. Any suggestions on improving the code are highly appreciated.
Features
-
UI Improvements
- Define areas on the screen that can be used to show/hide default UI elements on mouseover (action bars, main menu, etc.).
- Hide action bar lock.
- Action bar paging - swap the main action bar page while holding down a modifier key.
- Action bar button row reordering, inverts row order.
- Display duty finder queue information in "Server Info" bar.
-
Job HUD
- Timers and/or status bars for buffs and debuffs.
- Cooldowns, proccs, etc.
- Alerts similar to World of Warcraft's SpellActivationOverlay/WeakAuras.
- Images are not included, as I currently use those from Blizzard, you better disable the alerts unless you like placeholder rectangles.
- Super minimalistic, totally not configurable yet (use XIVAuras).
-
Cooldown Bars
- Bars. For cooldowns.
- Pulse animation when a cooldown finishes (similar to Doom_CooldownPulse).
- Also, there's no configuration yet for the list of enabled spells.
-
Plugin Menu
- Buttons that execute a command when clicked. Similar to QoLBar, but no additional features or logic besides the (optional) coloring based on another plugins property. They are pretty though.
FAQ
See the open issues for a full list of proposed features (and known issues) after reading the whole FAQ.
1. How do I.../I want to.../Why doesn't... ?
I told you not to use this plugin, didn't I? ;) As already stated before this is a work in progress, If you think something isn't working like *I* wanted it to work and it isn't totally obvious feel free to report a bug after reading about known issues first.
2. Feature Requests
My main goal is to get all the features in that are important to me personally. Requesting features is fine, but don't expect anything. (For reference: My World of Warcraft UI still hasn't got settings for all modules and exists for more than a decade now.)
3. Known Issues
-
Profiles/Exporting/Importing: The current implemenation of resetting configurations causes issues with how I setup the plugin and I haven't gotten time to change this. Switching to another profile/resetting a profile and reloading the plugin afterwards might be fine, but I don't know - I don't use profiles.
-
Missing/Useless/Nonworking configuration items: Yep.
4. See #1
Getting Started
SezzUI is a plugin for Dalamud, in order to use it you need to install XIVLauncher first. Dalamud should be enabled by default (if it is not you can enable it in the launcher settings).
XIVLauncher is available at https://goatcorp.github.io/, the source code is on GitHub: https://github.com/goatcorp/FFXIVQuickLauncher
Prerequisites
- Read the FAQ
- Install XIVLauncher
Installation
-
Open Dalamud settings after launching the game by typing
/xlsettingsin chat (or using the fancy new menu at the top left of your screen when you're at the character selection). -
Go to the "Experimental" tab and add the following URL to "Custom Plugin Repositories" (don't forget to click the small plus button on the right side):
https://ffxiv.sezz.at/repo.json -
Optional: Enable "Plugin Testing Builds" to try the lastest build (if there is one).
-
Save and Close.
-
Open Dalamud's plugin installer using
/xlplugins- you should now be able to install and update SezzUI from there (it should be listed in the UI category).
Usage
The command /sezzui opens the configuration window. The first thing you want do is to disable everything, because most of the default configuration is how I use the plugin.
Now go ahead and read the FAQ (seriously).
For more information, please refer to the Documentation.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Contact
Martin Karer - @sezz - https://sezz.at - Discord: Sezz#3415
Please refrain from trying to contact me directly via anything else than email unless you don't expect an answer within the next 12 months. I'm sure you can figure out the address if your enquiry is of major importance.
License
Distributed under the GNU AGPL-3.0 License. See LICENSE for more information.
Acknowledgments
Most of the base framework and configuration code is taken from DelvUI which saved me a tremendous amount of time to get things going. Additional credits, detailed image sources, etc. are listed in the plugin.
Disclaimer
FINAL FANTASY is a registered trademark of Square Enix Holdings Co., Ltd. FINAL FANTASY XIV © 2010-2022 SQUARE ENIX CO., LTD. All Rights Reserved. I'm not affiliated with SQUARE ENIX CO., LTD. in any way.