Add readme and remove agent
This commit is contained in:
@@ -6,9 +6,7 @@ local debug = false
|
|||||||
|
|
||||||
---@type Channel[]
|
---@type Channel[]
|
||||||
local channels = {
|
local channels = {
|
||||||
{ name = "Agent", password = "agents42" },
|
|
||||||
{ name = "Horde", password = "garrosh" },
|
{ name = "Horde", password = "garrosh" },
|
||||||
{ name = "Foobar", password = "123" },
|
|
||||||
{ name = "world_ru", password = nil }
|
{ name = "world_ru", password = nil }
|
||||||
}
|
}
|
||||||
---@type string
|
---@type string
|
||||||
|
50
README.md
Normal file
50
README.md
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
# Channeler
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
Channeler is a World of Warcraft AddOn that helps manage and organize chat channels and windows, providing a customized chat experience for players.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Automatically joins predefined chat channels
|
||||||
|
- Creates custom chat windows with specific message groups and channels
|
||||||
|
- Provides a quick reconfiguration slash command
|
||||||
|
|
||||||
|
## Predefined Channels
|
||||||
|
The AddOn automatically joins the following channels:
|
||||||
|
- Horde (password: garrosh)
|
||||||
|
- world_ru (no password)
|
||||||
|
|
||||||
|
## Subscribed Message Groups
|
||||||
|
The AddOn subscribes to the following message types:
|
||||||
|
- SAY
|
||||||
|
- YELL
|
||||||
|
- EMOTE
|
||||||
|
- PARTY
|
||||||
|
- PARTY_LEADER
|
||||||
|
- RAID
|
||||||
|
- RAID_LEADER
|
||||||
|
- RAID_WARNING
|
||||||
|
- BATTLEGROUND
|
||||||
|
- BATTLEGROUND_LEADER
|
||||||
|
- INSTANCE_CHAT
|
||||||
|
- INSTANCE_CHAT_LEADER
|
||||||
|
- WHISPER
|
||||||
|
|
||||||
|
## Chat Windows
|
||||||
|
Two custom chat windows are created:
|
||||||
|
1. "Auto" - Includes all subscribed message groups and channels (Agent, Horde, Foobar)
|
||||||
|
2. "world_ru" - Dedicated to the world_ru channel
|
||||||
|
|
||||||
|
## Slash Commands
|
||||||
|
- `/fix` or `/f`: Reconfigures chat windows and channels
|
||||||
|
|
||||||
|
## Versions
|
||||||
|
- 1 tab - horde only
|
||||||
|
- 2 tab - horde, world_ru
|
||||||
|
- 3 tab - horde, world_ru, everything else
|
||||||
|
- 2 tab - horde+everything else, world_ru
|
||||||
|
- 1 tab - horde+everything else
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
1. Download the [addon](https://git.site.quack-lab.dev/dave/wow_channeler/raw/branch/master/Channeler.zip)
|
||||||
|
2. Extract the AddOn to your World of Warcraft `Interface/AddOns` directory
|
||||||
|
3. Ensure the AddOn is enabled in the character selection screen
|
Reference in New Issue
Block a user