Add README
This commit is contained in:
43
README.md
Normal file
43
README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Dechickenator
|
||||
|
||||
## Overview
|
||||
Dechickenator is a World of Warcraft addon that provides flexible buff and aura management with custom alerts and actions.
|
||||
|
||||
## Versions
|
||||
- **v1 (Master)**: Simple buff removal with predefined actions
|
||||
- **v2.0**: More complex alert system with customizable actions
|
||||
|
||||
## Features
|
||||
- Automatically remove unwanted buffs
|
||||
- Create custom alerts for specific spell auras
|
||||
- Send personalized chat messages when buffs are applied
|
||||
- Perform custom emotes triggered by specific buffs
|
||||
|
||||
## Installation
|
||||
1. Extract the addon to your World of Warcraft `Interface/AddOns` directory
|
||||
2. Ensure the addon is enabled in the character selection screen
|
||||
|
||||
## Usage
|
||||
Use the `/dechicken` slash command to configure alerts with the following syntax:
|
||||
|
||||
### Command Structure
|
||||
`/dechicken a:SpellName;[options]`
|
||||
|
||||
### Options
|
||||
- `a:` - Spell/Aura name (required)
|
||||
- `e:` - Emote to perform
|
||||
- `m:` - Custom message to send (supports `%s` for source name)
|
||||
- `c:` - Chat channel (default: SAY)
|
||||
- `R` - Automatically remove the buff
|
||||
|
||||
### Examples
|
||||
```
|
||||
# Remove "Greater Blessing of Kings" and send a message
|
||||
/dechicken a:Greater Blessing of Kings;R;m:No buffs please!
|
||||
|
||||
# Perform a laugh emote when "Turkey Feathers" is applied
|
||||
/dechicken a:Turkey Feathers;e:laugh
|
||||
|
||||
# Send a custom message in YELL channel
|
||||
/dechicken a:Some Buff;m:Hey %s, nice buff!;c:YELL
|
||||
```
|
Reference in New Issue
Block a user