Bolden the reports, they are the highlights here

2024-12-27 16:21:41 +01:00
parent bfaa73b660
commit af2a714b76
1 changed files with 69 additions and 69 deletions
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ Heimdall is a multi-module addon that offers various functionalities to enhance
  - Faction
  - Health
  - Location
- Example report:
+- **Example report:**
 	- "I see (Hostile) Atomickitty of race Blood Elf (Horde) with health 6.8M/6.8M at Orgrimmar (Valley of Strength)"
 	- "I see (<reaction>) <name> of race <race> (<faction>) with health <health>/<healthMax> at <location>"
 - Configuration:
@@ -50,7 +50,7 @@ Heimdall is a multi-module addon that offers various functionalities to enhance
  - Players disappear from tracking
 - Supports whisper notifications to predefined contacts
 - Plays sound alerts for "stinky" players
- Example report:
+- **Example report:**
  - Player appeared:
    - "Любящаядева of class Mage, race Human (Alliance) and guild Анонимное сообщество in Valley of Trials, first seen: 2024-12-27T15:54:38, last seen: never, times seen: 0"
    - "<name> of class <class>, race <race> (<faction>) and guild <guild> in <zone>, first seen: <firstSeen>, last seen: <lastSeen>, times seen: <timesSeen>"
@@ -108,14 +108,13 @@ Heimdall is a multi-module addon that offers various functionalities to enhance
 - Implements throttling to prevent spam
 - Handles duel detection to avoid reporting duel-related deaths
 - Sends notifications to a specified channel and optional whisper contacts
- Example report:
+- **Example report:**
+  - "Euotuie killed Wild Mature Swine with Demon's Bite in Durotar (The Dranosh'ar Blockade)"
+  - "<killer> killed <victim> with <spell> in <zone> (<subzone>)"
 - Configuration:
  - `enabled` - Whether the module is enabled
  - `notifyChannel` - The channel to report to (by name)
  - `doWhisper` - Whether to whisper to predefined contacts
- Example report:
-  - "Euotuie killed Wild Mature Swine with Demon's Bite in Durotar (The Dranosh'ar Blockade)"
-  - "<killer> killed <victim> with <spell> in <zone> (<subzone>)"
 - Configuration example:
 ```
 /run Heimdall_Data.config.deathReporter = {enabled=true,notifyChannel="Agent",doWhisper=true}
@@ -145,20 +144,20 @@ The addon maintains a list of "stinky" players - users of interest that trigger

 ---

-# Heimdall WoW Аддон
+# Аддон Heimdall для WoW

-Heimdall - это всеобъемлющий аддон для World of Warcraft, разработанный для предоставления расширенных функций отслеживания игроков, уведомлений и управления группами.
+Heimdall - это комплексный аддон для World of Warcraft, предназначенный для расширенного отслеживания игроков, уведомлений и управления группами.

 ## Обзор

-Heimdall - это многомодульный аддон, предлагающий различные функции для улучшения взаимодействия и осведомленности игроков в игре. Он состоит из нескольких ключевых модулей, каждый с определенной целью:
+Heimdall - это многомодульный аддон, предоставляющий различные функции для улучшения взаимодействия между игроками и повышения осведомленности в игре. Он состоит из нескольких ключевых модулей:

-### 1. Модуль Spotter (`Spotter.lua`)
- Отслеживает и сообщает о появлении игроков в реальном времени
+### 1. Модуль Обнаружения (`Spotter.lua`)
+- Отслеживает и сообщает об обнаружении игроков в реальном времени
 - Настраиваемые параметры уведомлений:
  - Обнаружение игроков по фракции (Альянс, Орда)
-  - Идентификация враждебных игроков
-  - Пометка "вонючих" игроков (предопределенный список)
+  - Определение враждебных игроков
+  - Отметка "подозрительных" игроков (предопределенный список)
 - Отправляет уведомления в указанный канал при обнаружении игроков
 - Предоставляет подробную информацию об обнаруженных игроках:
  - Имя
@@ -166,59 +165,60 @@ Heimdall - это многомодульный аддон, предлагающ
  - Фракция
  - Здоровье
  - Местоположение
- Пример отчета:
-	- "Вижу (Враждебный) Атомическийкот расы Эльф Крови (Орда) с здоровьем 6.8М/6.8М в Оргриммаре (Долина Силы)"
+- **Пример отчета:**
+  - "Обнаружен (Враждебный) Atomickitty расы Эльф Крови (Орда) со здоровьем 6.8M/6.8M в Оргриммаре (Долина Силы)"
+  - "Обнаружен (<реакция>) <имя> расы <раса> (<фракция>) со здоровьем <здоровье>/<макс_здоровье> в <локация>"
 - Конфигурация:
-	- `enabled` - Включен ли модуль
-	- `everyone` - Сообщать ли всем в канале
-	- `hostile` - Сообщать ли о враждебных игроках
-	- `alliance` - Сообщать ли об игроках Альянса
-	- `stinky` - Сообщать ли только о "вонючих" игроках
-	- `notifyChannel` - Канал для отчетов
-	- `zoneOverride` - Зона для переопределения
-	- `throttleTime` - Время задержки отчетов (в секундах)
+  - `enabled` - Включен ли модуль
+  - `everyone` - Сообщать ли всем в канале
+  - `hostile` - Сообщать ли о враждебных игроках
+  - `alliance` - Сообщать ли об игроках Альянса
+  - `stinky` - Сообщать ли только о подозрительных игроках
+  - `notifyChannel` - Канал для отправки сообщений (по имени)
+  - `zoneOverride` - Зона для переопределения местоположения игрока
+  - `throttleTime` - Время задержки между сообщениями (в секундах)
 - Пример конфигурации:
 ```
 /run Heimdall_Data.config.spotter = {enabled=true,everyone=false,hostile=true,alliance=true,stinky=true,notifyChannel="Agent",zoneOverride=nil,throttleTime=10}
 ```

-### 2. Модуль Whoer (`Whoer.lua`)
- Расширенная система отслеживания и логирования игроков
- Периодически выполняет WHO-запросы в определенных зонах
+### 2. Модуль WHO (`Whoer.lua`)
+- Продвинутая система отслеживания и логирования игроков
+- Периодически выполняет WHO запросы в определенных зонах
 - Поддерживает постоянную базу данных информации об игроках:
  - Первое появление
  - Последнее появление
  - Количество появлений
  - История зон
- Отправляет уведомления при:
-  - Обнаружении новых игроков
-  - Смене зон игроками
-  - Исчезновении игроков из отслеживания
- Поддерживает whisper-уведомления предопределенным контактам
- Воспроизводит звуковые оповещения для "вонючих" игроков
- Пример отчета:
+- Отправляет уведомления когда:
+  - Обнаружены новые игроки
+  - Игроки меняют зоны
+  - Игроки исчезают из отслеживания
+- Поддерживает уведомления шепотом предопределенным контактам
+- Проигрывает звуковые оповещения для "подозрительных" игроков
+- **Пример отчета:**
  - Появление игрока:
-    - "Любящаядева класса Маг, расы Человек (Альянс) и гильдии Анонимное сообщество в Долине Испытаний, впервые замечен: 2024-12-27T15:54:38, последний раз замечен: никогда, раз замечен: 0"
+    - "Любящаядева класса Маг, раса Человек (Альянс) из гильдии Анонимное сообщество в Долине Испытаний, первое появление: 2024-12-27T15:54:38, последнее появление: никогда, появлений: 0"
  - Смена зоны:
-    - "Королевский Лорд класса Паладин (Человек - Альянс) и гильдии Ночные Странники переместился в Дуротар"
+    - "Thekinglord класса Паладин (Человек - Альянс) из гильдии Caminantes Nocturnos R переместился в Дуротар"
  - Исчезновение:
-    - "Королевский Лорд класса Паладин и гильдии Ночные Странники покинул Долину Испытаний"
+    - "Thekinglord класса Паладин из гильдии Caminantes Nocturnos R покинул Долину Испытаний"
 - Конфигурация:
  - `enabled` - Включен ли модуль
-  - `notifyChannel` - Канал для отчетов
-  - `ttl` - Время жизни игрока (в секундах)
-  - `doWhisper` - Отправлять ли whisper предопределенным контактам
-  - `zoneNotifyFor` - Уведомлять ли о игроках в определенных зонах
+  - `notifyChannel` - Канал для отправки сообщений
+  - `ttl` - Время жизни записи об игроке (в секундах)
+  - `doWhisper` - Отправлять ли шепот контактам
+  - `zoneNotifyFor` - Уведомлять ли об игроках в определенных зонах
 - Пример конфигурации:
 ```
-/run Heimdall_Data.config.who = {enabled=true,notifyChannel="Agent",ttl=20,doWhisper=true,zoneNotifyFor={["Оргриммар"]=true,["Громовой Утес"]=true,["Подгород"]=true,["Дуротар"]=true,["Эховые Острова"]=true,["Долина Испытаний"]=true}}
+/run Heimdall_Data.config.who = {enabled=true,notifyChannel="Agent",ttl=20,doWhisper=true,zoneNotifyFor={["Orgrimmar"]=true,["Thunder Bluff"]=true,["Undercity"]=true,["Durotar"]=true,["Echo Isles"]=true,["Valley of Trials"]=true}}
 ```

-### 3. Модуль Messenger (`Messenger.lua`)
- Централизованная система очереди и отправки сообщений
- Управляет доставкой сообщений через различные чат-каналы
+### 3. Модуль Сообщений (`Messenger.lua`)
+- Централизованная система очередей и отправки сообщений
+- Управляет доставкой сообщений по разным чат-каналам
 - Обрабатывает присоединение к каналам и маршрутизацию сообщений
- Предоставляет надежную инфраструктуру обмена сообщениями для других модулей
+- Предоставляет надежную инфраструктуру сообщений для других модулей
 - Конфигурация:
  - `enabled` - Включен ли модуль
 - Пример конфигурации:
@@ -226,37 +226,37 @@ Heimdall - это многомодульный аддон, предлагающ
 /run Heimdall_Data.config.messenger = {enabled=true}
 ```

-### 4. Модуль Inviter (`Inviter.lua`)
- Автоматизированная система приглашений в группу
- Прослушивает определенный канал на предмет запросов приглашений
+### 4. Модуль Приглашений (`Inviter.lua`)
+- Автоматическая система приглашений в группу
+- Прослушивает определенный канал на запросы приглашений
 - Поддерживает настраиваемое ключевое слово для приглашений
- Автоматически повышает членов канала до помощников в рейдовых группах
+- Автоматически повышает участников канала до помощников в рейдовых группах
 - Конфигурация:
  - `enabled` - Включен ли модуль
  - `keyword` - Ключевое слово для прослушивания
-  - `updateInterval` - Интервал обновления списка членов канала (в секундах)
+  - `updateInterval` - Интервал обновления списка участников канала (в секундах)
  - `listeningChannel` - Канал для прослушивания приглашений
 - Пример конфигурации:
 ```
 /run Heimdall_Data.config.inviter = {enabled=true,keyword="+",updateInterval=10,listeningChannel="Agent"}
 ```

-### 5. Модуль Death Reporter (`DeathReporter.lua`)
+### 5. Модуль Отчетов о Смертях (`DeathReporter.lua`)
 - Отслеживает и сообщает о смертях игроков в бою
- Захватывает подробную информацию о смерти:
+- Сохраняет подробную информацию о смерти:
  - Убийца
  - Жертва
-  - Заклинание убийства
+  - Убивающее заклинание
  - Местоположение
- Реализует торможение для предотвращения спама
- Обрабатывает обнаружение дуэлей, чтобы избежать сообщений о смертях в дуэлях
- Отправляет уведомления в указанный канал и необязательным контактам whisper
- Пример отчета:
-  - "Еуотуие убил Дикого Зрелого Кабана заклинанием Укус Демона в Дуротаре (Блокада Дранош'ара)"
+- Реализует задержку для предотвращения спама
+- Обрабатывает определение дуэлей во избежание сообщений о смертях в дуэлях
+- Отправляет уведомления в указанный канал и опционально шепотом контактам
+- **Пример отчета:**
+  - "Euotuie убил Wild Mature Swine с помощью Demon's Bite в Дуротаре (Блокпост Дранош'ар)"
 - Конфигурация:
  - `enabled` - Включен ли модуль
-  - `notifyChannel` - Канал для отчетов
-  - `doWhisper` - Отправлять ли whisper
+  - `notifyChannel` - Канал для отправки сообщений
+  - `doWhisper` - Отправлять ли шепот контактам
 - Пример конфигурации:
 ```
 /run Heimdall_Data.config.deathReporter = {enabled=true,notifyChannel="Agent",doWhisper=true}
@@ -266,19 +266,19 @@ Heimdall - это многомодульный аддон, предлагающ
 - Инициализирует и настраивает все остальные модули
 - Управляет глобальной конфигурацией и сохранением данных
 - Предоставляет служебные функции для:
-  - Работы со строками UTF-8
-  - Дополнения строк
-  - Получения данных со значениями по умолчанию
+  - Обработки UTF-8 строк
+  - Выравнивания строк
+  - Получения данных с значениями по умолчанию

-## "Вонючие" Игроки
+## Подозрительные Игроки

-Аддон поддерживает список "вонючих" игроков - пользователей интереса, которые вызывают специальные уведомления и отслеживание.
+Аддон поддерживает список "подозрительных" игроков - пользователей, представляющих интерес, которые вызывают специальные уведомления и отслеживание.

-## Slash-команды
+## Слэш-команды

- `/has [Имя Игрока]`: Переключить статус "вонючести" игрока
+- `/has [ИмяИгрока]`: Переключить статус "подозрительного" игрока

 ## Установка
 1. Скачайте [аддон](https://git.site.quack-lab.dev/dave/wow-Heimdall/media/branch/master/Heimdall.zip)
-2. Извлеките аддон в папку `Interface/AddOns` вашего World of Warcraft
-3. Убедитесь, что аддон включен на экране выбора персонажа
+2. Распакуйте аддон в директорию World of Warcraft `Interface/AddOns`
+3. Убедитесь, что аддон включен на экране выбора персонажа