From 376e3ec616c9090effb180ffb0f9c848d99a8b7b Mon Sep 17 00:00:00 2001 From: PhatPhuckDave Date: Fri, 27 Dec 2024 15:48:06 +0100 Subject: [PATCH] Fix up readme --- README.md | 167 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 132 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 6405799..e87db70 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,139 @@ # Yapper -## World of Warcraft addon that *yaps* a given message in a given channel every now and then +## Overview +Yapper is a World of Warcraft addon that allows you to automatically send messages to various in-game chat channels at specified intervals. Whether you want to spam a joke in guild chat, set an AFK message, or communicate across different channels, Yapper makes it easy. -## Download [here!](https://git.site.quack-lab.dev/dave/wow-Yapper/media/branch/master/Yapper.zip) +## Features +- Configurable message interval +- Support for multiple chat channels +- Persistent settings across game sessions +- Simple slash command interface -All settings are saved and persist through sessions! +## Installation +1. Download the latest version from the [Yapper release page](https://git.site.quack-lab.dev/dave/wow-Yapper/media/branch/master/Yapper.zip) +2. Extract the ZIP file +3. Place the `Yapper` folder in your World of Warcraft `_retail_/Interface/AddOns/` directory +4. Ensure the addon is enabled in the character selection screen -Interfacing with the addon is done entirely through two commands: +## Usage Commands -## `/yap` -- Main command that controls most of the parameters -- Simply running `/yap` will cause the yapper to begin... yapping -- `/yap ` sets the yap interval - - `/yap 30` would send a message every 30 seconds -- `/yap ` sets the yap message - - `/yap I'm a big strong boy!` would set the message to "I'm a big strong boy!" +### `/yap` +The primary command for controlling Yapper's core functionality: -## `/yapc` -- Controls the channel in which yapping takes place - - The available channels are: - - `CHANNEL` - Message to a server or custom chat channel (sent with /1, /2, etc in the default UI); requires channel number for channel argument - - `DND` - Enables Away-From-Keyboard status for the player, with text as the custom message seen by others attempting to whisper the player - - `EMOTE` - Custom text emotes visible to nearby players (sent with /e in the default UI) - - `GUILD` - Messages to guild members (sent with /g in the default UI) - - `INSTANCE_CHAT` - Messages to a LFG/LFR instance group (sent with /i in the default UI) - - `OFFICER` - Messages to guild officers (sent with /o in the default UI) - - `PARTY` - Messages to party members (sent with /p in the default UI) - - `RAID` - Messages to raid members (sent with /ra in the default UI) - - `RAID_WARNING` - Warning to raid members (sent with /rw in the default UI) - - `SAY` - Speech to nearby players (sent with /s in the default UI) - - `WHISPER` - Message to a specific character (sent with /w in the default UI); requires name of the character for channel argument - - `YELL` - Yell to not-so-nearby players (sent with /y in the default UI) -- Some channels also require special data such as "CHANNEL" and "WHISPER" - - For `WHISPER` that is the target being whispered - - For `CHANNEL` that is the channel name -- Example: - - `/yapc SAY` will make yapper use the say channel (/s) - - `/yapc YELL` will use yell channel (/y) - - `/yapc WHISPER` will error out - we are missing a recipient! - - `/yapc WHISPER Pinkleta` will whisper Pinkleta - - `/yapc CHANNEL world_ru` will yap to world channel \ No newline at end of file +- Start yapping: `/yap` +- Set yap interval: `/yap ` + - Example: `/yap 30` sends a message every 30 seconds +- Set yap message: `/yap ` + - Example: `/yap I'm a big strong boy!` + +### `/yapc` +Controls the chat channel for your messages: + +#### Supported Channels +- `SAY`: Speak to nearby players +- `YELL`: Yell to not-so-nearby players +- `GUILD`: Message guild members +- `PARTY`: Message party members +- `RAID`: Message raid members +- `RAID_WARNING`: Send a raid warning +- `INSTANCE_CHAT`: Message LFG/LFR group +- `OFFICER`: Message guild officers +- `EMOTE`: Send a custom text emote +- `DND`: Set Away-From-Keyboard status +- `WHISPER`: Message a specific character +- `CHANNEL`: Message a custom chat channel + +#### Channel-Specific Examples +- `/yapc SAY` - Use say channel +- `/yapc YELL` - Use yell channel +- `/yapc WHISPER Pinkleta` - Whisper a specific player +- `/yapc CHANNEL world_ru` - Message a custom channel + +## Example Scenarios +1. Periodic Guild Joke: + ``` + /yap Hey guys, knock knock! + /yapc GUILD + /yap 300 # Tells a joke every 5 minutes + ``` + +### `/yapl` +Changes language of the "debug" messages of the addon. + +Example: +``` +/yapl ru +``` +``` +/yapl en +``` + +# Yapper; Ruski + +## Обзор +Yapper - это аддон для World of Warcraft, позволяющий автоматически отправлять сообщения в различные внутриигровые каналы чата через заданные интервалы. Будь то спам шутками в гильдейском чате, установка AFK-сообщения или общение в разных каналах, Yapper делает это простым. + +## Возможности +- Настраиваемый интервал сообщений +- Поддержка множества каналов чата +- Сохранение настроек между игровыми сессиями +- Простой интерфейс слэш-команд + +## Установка +1. Скачайте последнюю версию со [страницы релизов Yapper](https://git.site.quack-lab.dev/dave/wow-Yapper/media/branch/master/Yapper.zip) +2. Распакуйте ZIP-файл +3. Поместите папку `Yapper` в директорию World of Warcraft `_retail_/Interface/AddOns/` +4. Убедитесь, что аддон включен на экране выбора персонажа + +## Команды использования + +### `/yap` +Основная команда для управления функциональностью Yapper: + +- Начать отправку: `/yap` +- Установить интервал: `/yap <число>` + - Пример: `/yap 30` отправляет сообщение каждые 30 секунд +- Установить сообщение: `/yap <текст>` + - Пример: `/yap Я большой и сильный!` + +### `/yapc` +Управляет каналом чата для сообщений: + +#### Поддерживаемые каналы +- `SAY`: Говорить с ближайшими игроками +- `YELL`: Кричать не очень близким игрокам +- `GUILD`: Сообщения членам гильдии +- `PARTY`: Сообщения членам группы +- `RAID`: Сообщения членам рейда +- `RAID_WARNING`: Отправить предупреждение рейду +- `INSTANCE_CHAT`: Сообщения группе LFG/LFR +- `OFFICER`: Сообщения офицерам гильдии +- `EMOTE`: Отправить пользовательскую эмоцию +- `DND`: Установить статус "Не беспокоить" +- `WHISPER`: Сообщение конкретному персонажу +- `CHANNEL`: Сообщение в пользовательский канал чата + +#### Примеры для каналов +- `/yapc SAY` - Использовать канал "сказать" +- `/yapc YELL` - Использовать канал "крик" +- `/yapc WHISPER Pinkleta` - Шепнуть конкретному игроку +- `/yapc CHANNEL world_ru` - Сообщение в пользовательский канал + +## Примеры сценариев +1. Периодическая шутка в гильдии: + ``` + /yap Эй, ребята, тук-тук! + /yapc GUILD + /yap 300 # Рассказывает шутку каждые 5 минут + ``` + +### `/yapl` +Изменяет язык "отладочных" сообщений аддона. + +Примеры: +``` +/yapl ru +``` +``` +/yapl en +``` \ No newline at end of file