ToxiUI: Enhancing Your World of Warcraft Experience

Welcome to ToxiUI, a thoughtfully crafted plugin for the renowned ElvUI, meticulously designed by Toxi. If you're seeking a seamless and visually appealing overhaul for your World of Warcraft interface, you're in the right place. ToxiUI seamlessly combines functionality and aesthetics, ensuring that your gaming experience reaches new heights of enjoyment and efficiency.

Why ToxiUI?

Effortless Installation

Gone are the days of complex installation processes. ToxiUI prides itself on a straightforward installation that doesn't require a degree in rocket science. With clear instructions and user-friendly steps, you'll be up and running with ToxiUI in no time.

WunderBar: Your Modern Data Panel

Experience the future of data panels with WunderBar. ToxiUI introduces a modern and customizable data panel that serves as your one-stop hub for crucial information. Whether you're tracking your character's statistics, managing resources, or just staring at the clock while afk running around the capital city, WunderBar offers unparalleled convenience and customization.

A World of Themes and Customization

ToxiUI empowers you to personalize your World of Warcraft interface. With three distinct themes to choose from, you can align your UI with your personal style or adapt it to match your character's journey. And if that's not enough, the ability to easily customize gradient colors ensures your UI remains as unique as your adventure.

Community-Driven Evolution

ToxiUI is not just a modification; it's a collaborative journey driven by the World of Warcraft community. As an open-source project, it thrives on the collective expertise and passion of players like you. While the pace of official development might have eased, the heart of ToxiUI beats stronger than ever through community contributions.

Tailored for Diverse Playstyles

Whether you're a damage-dealing dynamo or a healing virtuoso, ToxiUI has you covered. It offers specialized layouts for DPS and healers, optimizing your interface for the roles you excel in. No matter your preferred playstyle, ToxiUI adapts to amplify your performance.

Embrace ToxiUI

Elevate your World of Warcraft journey with ToxiUI. Seamlessly merging minimalist design, cutting-edge functionality, and immersive customization, ToxiUI stands as the ultimate UI modification for players who demand the best. Join the ranks of adventurers who have embraced ToxiUI and experience Azeroth like never before.

How to keep up to date with repo

Windows OS

1. Clone the repository
2. git checkout development
3. Create a symlink directory junction
   1. Open up Command Prompt as administator
   2. mklink /J <new path> <old path>

Example:

mklink /J "D:\Games\World of Warcraft\_retail_\Interface\AddOns\ElvUI_ToxiUI\" C:\Users\Toxi\Documents\GitHub\toxiui

Development workflow

Use the development branch

The stable branch should be updated only every big (non-beta) release, so that we have a reference.

⚠️ 2023-07-15: Moving the release CI to development branch. stable will only be used as a reference point, but even then not sure if needed with the amount of commits we have nowadays.

Pull requests only

⛔️ Please do not push code to the stable or development branches and only use Pull Requests.

Commit messages

We use a VSCode extension called Emoji Log for commit messages. This is so that #📦git-feed is readable and easy to understand.

ℹ️ Commits including TEST: will be exluded from the changelog in #build-releases

🔗 https://marketplace.visualstudio.com/items?itemName=ahmadawais.emoji-log-vscode

Code formatting

Please install the stylua extension and setup to format on save

// settings.json
{
    "editor.formatOnSave": true,
    "[lua]": {
        "editor.defaultFormatter": "JohnnyMorganz.stylua"
    },
}

🔗 https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.stylua

Chat Commands:

General (user facing)

Prefix: /tx /txui /toxi /toxiui

/tx - ElvUI TXUI Options Dialog (alias of /tx settings)
/tx changelog - ElvUI TXUI Options showing ONLY the changelog
/tx wb - ElvUI TXUI Options showing ONLY WunderBar
/tx badge - Disable chat badges (only possible if you actually have a chat badge)
/tx export names - Export a list of all character names where ElvUI was active
/tx reset - Resets all TXUI Settings (not the ElvUI profile itself, tho a re-install is needed to gain access to TXUI features back)
/tx status - Shows the Diagnostic Popup (alias of /tx info)
/tx install - Shows the Installer Dialog for TXUI

Dev Section (or beta builds)

/tx dev profile [dps|healer] - Install the ElvUI Profile without confirmation
/tx dev cvar - Sets the default ElvUI Cvars (+ personal change)
/tx dev chat - Install a custom chat config
/tx dev wb - Enables the wunderbar debug mode
/tx dev splash - Shows the Splashscreen for 15 Seconds
/tx dev dpi - Gives you a scaled pixel perfect number (Magic Config Number -> Actual Number)

Devs Only

/tx dev toggle - Toggles Developer mode, which activates overrides and custom features (like Escape-Menu Background etc)

Exports

/tx dev export bw [dps|healer] - Exports the BigWigs profile for DPS or Healer
/tx dev export names - Triggers the import of badge names (decode)