= Chorus
Vladyslav Bondarenko <vladyslavbond@protonmail.com>
0.14.2, 2025-03-07
:homepage: https://gitlab.com/vladyslavbond/chorus

"Chorus" is an add-on for "World of Warcraft" game. It replaces native player,
target, focus, party and raid frames with custom frames.

At the time of writing, the add-on only fully supports legacy version of "Wrath
of the Lich King" client. The retail "Classic" version is not supported.

This is a work in progress.

Everyone is free to use, copy, share, and modify any part or all of this
project, for any purpose.

== Features

- user selects from three preset raid frame profiles, optimized for different
group sizes;
- toggle party frame in raid groups;
- display approximate distance to group members or target in yards;
- draggable unit, party and raid group frames;
- combo points frame for target and focus;
- set player role to tank, healer or damager explicitly;
- detailed health, mana and other power bars;
- sort buffs and debuffs by relevance;

== Known issues

Most known errors and planned features are documented in the source code, using
`@todo` and `@fixme` tags, intended to be processed by `lua-ldoc`.

The most notable issues are related to globalization, compatibility between
different game client versions and minor visual glitches.

Only English version of the client completely supports buff and debuff sorting.

Party frame works for the user team in arena, but not for enemy team. Most
players will likely use a purpose built add-on for arena frames anyway.

See HTML documentation in `doc/html/index.html`.

== Future goals

Create a minimalist, robust raid frame, that requires little to no
configuration from the user.

Add features that are comparable to native "Compact Raid Frames" introduced in
"Cataclysm".

Remain maintainable.

Support legacy versions of "Wrath of the Lich King", "Cataclysm" and "Mists of
Pandaria" expansions equally, within the single source code base.

include::doc/installation.adoc[]
include::doc/build.adoc[]