Toxicom / toxiui

ToxiUI is a plugin for ElvUI in World of Warcraft
Other
24 stars 15 forks source link

Gameplay video

Video thumbnail

Click the image above to see the video

 

Features

Requirements

Required AddOns:

Recommended AddOns:

Additional supported AddOns:

Installation

Installation video guide

Click the image above to see the video

 

Credits

Discord

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

Emoji Log Extension

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

Exports

/tx dev export names - Triggers the import of badge names (decode)