Обновить README.md

README.md

@@ -1,3 +1,27 @@
-# RAMPAGE
+# RAMPAGE.lua
 
-Automatically displays animated notifications with GIFs, sound, and text on kills. Supports content customization and features a triple verification system for stable operation 
+Автоматически отображает анимированные уведомления с гифками, звуком и текстом при убийствах. Поддерживает* кастомизацию контента и имеет тройную систему проверки для стабильной работы.
+
+## Инструкция по установке для неуверенных пользователей ПК
+- Скачать последнюю версию архива RAMPAGE.zip, воспользовавшись вкладкой Releases. Последняя версия помечена как (Latest);
+- Все содержимое архива RAMPAGE.zip перекинуть в папку moonloader;
+- Пользоваться.
+
+## Описание функционала
+- Отрисовывает при убийстве противника гифку и текст, при этом проигрывая звук;
+- Имеет счетчик убийств, в результате будет показан текст, предназначенный для, например, третьего убийства;
+- Имеет плавное пропадание текста и гифки;
+- Более проработанная система проверки на убийстве по сравнению с killsay;
+- Активация автоматическая, меню и кастомизация внутри игры не предусмотрены.
+
+## *Информация о кастомизации (обязательно прочесть перед кастомизацией)
+- Кастомизируем GIF: файлы находятся в папке RAMPAGE/img и имеют названия от 1 до n. Чтобы загрузить свою gif необходимо поделить ее на кадры в формате .png, названия кадров обязательно должны быть 1.png, 2.png, n.png;
+- Кастомизируем текст: внутри кода ищем таблицу rampage_text, где 1 элемент таблицы - первый килл, второй элемент - второй килл. Меняете на любой текст на АНГЛИЙСКОМ ЯЗЫКЕ (русский не поддерживается), количество элементов таблицы значения не имеет: можно сделать хоть 1 элемент, хоть 50;
+- Кастомизируем звук: файл звука находится в папке RAMPAGE/sounds и имеет название sound.mp3. Для загрузки своего звука необходимо скачать его в формате mp3 и переименовать в sound.mp3 (можно воспользоваться конвертером если в другом формате), после вставляем с заменой. Желательно устанавливать звук продолжительностью в 3-4 секунды для стабильной работы.
+
+## Дополнительная информация
+- НЕ поддерживает русский язык в тексте;
+- Реализована тройная проверка на убийство: damage informer на Samp-RP, килллист, стандартная проверка из killsay;
+- damage informer и килллист имеют относительно одинаковый приоритет, стандартная проверка из killsay - минимальный;
+- ДЛЯ БОЛЕЕ СТАБИЛЬНОЙ РАБОТЫ НА SAMP-RP РЕКОМЕНДУЕТСЯ ВКЛЮЧИТЬ DAMAGE INFORMER В МЕНЮ СЕРВЕРА;
+- Зависимость от mimgui и стандартной библиотеки samp.events;