Add README

This commit is contained in:
2024-12-27 15:39:18 +01:00
parent b1dd53d6d9
commit 9925be5e0b

39
README.md Normal file
View File

@@ -0,0 +1,39 @@
# Dechickenator
## Overview
Dechickenator is a World of Warcraft addon that automatically manages unwanted buffs with custom messaging.
## Versions
- **v1 (Master)**: Simple buff removal with predefined actions
- **v2.0**: More complex alert system with customizable actions
## Features
- Automatically remove unwanted buffs
- Send custom emote messages when buffs are applied
- Perform "spit" emote on buff source
## 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
### Toggling Blacklisted Buffs
Use `/dechicken BuffName` to add or remove a buff from the blacklist.
### Customizing Message
Use `/dechicken_message Your custom message with %s for source name`
### Examples
```
# Toggle "Greater Blessing of Kings" blacklist
/dechicken Greater Blessing of Kings
# Set a custom message
/dechicken_message %s thinks they're special!
```
## Default Behavior
- When a blacklisted buff is applied, it will be automatically removed
- An emote message will be sent (default: "Индивидуум %s хочет поделиться своим истинным обликом")
- A "spit" emote will be performed towards the buff source