Настройка

Почти всё находится в одном коротком файле. Остальной Lua тоже оставлен открытым, так что при необходимости вы можете изменить само поведение.

Какой файл за что отвечает

Файл или папка	За что отвечает	Открыт?
`config.lua`	Фреймворк, язык, клавиша и команда меню, список птиц	Открыт
`locales/*.lua`	Тексты уведомлений, по одному файлу на язык	Открыт
`client/utils.lua`	Как показывается уведомление, для каждого фреймворка	Открыт
`client/client.lua`	Клавиша меню, команда `/parrot` и что делает каждая кнопка меню	Открыт
`client/bird_management.lua`	Как птица прилетает, садится, перемещается, следует и улетает	Открыт
`server/server.lua`	Регистрирует каждую птицу как используемый предмет и синхронизирует других игроков	Открыт
`html/`	Меню Bird Companion: `index.html`, `style.css`, `script.js` и его иконки в `html/img/`	Обычные файлы
`stream/`	Девять собственных моделей птиц	Ассеты
`flight.meta`	Данные педа для девяти собственных птиц	Данные
`inventory_images/`	Четырнадцать иконок предметов	Ассеты
`readme.md`	Готовые строки предметов для ox_inventory, QBCore и ESX	Справочник

locales/main.lua — единственный зашифрованный (escrow) файл Lua.

Общие настройки — `config.lua`

Параметр	Что делает	По умолчанию
`Config.Framework`	`esx`, `qb-core` или `qbox`. Определяет, как регистрируются предметы и показываются уведомления	`esx`
`Config.Locale`	Язык уведомлений: `en`, `es`, `de`, `fr`, `it`, `pl`, `pt`, `ru`, `tr`	`en`
`Config.MenuKey`	Индекс игрового управления, открывающего меню. `303` — это U	`303`
`Config.OpenMenuCommand`	Команда чата, открывающая меню	`parrot`
`Config.NoActiveBirdNotification`	Показывать сообщение, когда кто-то пытается открыть меню без птицы	`false`

Config.MenuKey — это номер управления FiveM, а не буква. Список номеров есть на справочной странице FiveM по управлению. Поскольку значение читается напрямую, игроки не могут переназначить его в собственных настройках; команда всегда остаётся как альтернатива.

Птицы — `Config.BirdItems`

Список соответствий название предмета → модель педа. Каждая запись при запуске становится используемым предметом.

Предмет	Модель
`crow`	`a_c_crow`
`pigeon`	`a_c_pigeon`
`seagull`	`a_c_seagull`
`cormorant`	`a_c_cormorant`
`chickenhawk`	`a_c_chickenhawk`
`macaw`	`Macaw`
`parrot`	`Parrot`
`falcon`	`Falcon`
`vulture`	`Vulture`
`eagle`	`Eagle`
`owl`	`Owl`
`hornbill`	`Hornbill`
`sparrow`	`Sparrow`
`warbler`	`Warbler`

Как добавить птицу

Добавьте строку в Config.BirdItems с названием нового предмета и моделью педа, которая должна появиться.
Добавьте предмет в ваш инвентарь так же, как остальные (см. Установку), и дайте ему иконку.
Птице из базовой игры (любой модели птицы a_c_…) больше ничего не нужно.
Собственной птице нужны файлы её модели в stream/ и собственная запись в flight.meta рядом с девятью существующими. Без записи в flight.meta модель загружается, но не ведёт себя как птица.
refresh, затем restart mic_parrots.

Как убрать птицу

Удалите её строку из Config.BirdItems. Предмет перестанет что-либо делать; удалите его и из вашего инвентаря, чтобы ни у кого не остался мёртвый предмет.

Меню — `html/`

Подписи меню (Bird Companion, Shoulder, Head, Dismiss, Follow, Close) записаны в html/index.html, а не в файлах локалей. Переводите или переименовывайте их там. Цвета и вёрстка находятся в html/style.css, а иконки кнопок — это PNG в html/img/.

В html/index.html также есть две закомментированные кнопки, Dance и Sing. За ними нет никаких действий в Lua, поэтому оставьте их закомментированными.

Esc или кнопка Close закрывает меню.

Языки

Поставляется девять, по одному файлу в locales/: en, es, de, fr, it, pl, pt, ru, tr. Выберите один через Config.Locale.

В каждом файле шесть строк: нет разрешения, у вас уже есть птица, на вашем плече нет птицы, птица уже на вашем плече, птица уже на вашей голове и для открытия меню нужна активная птица.

Чтобы добавить язык: скопируйте locales/en.lua в новый файл (например, locales/nl.lua), измените ключ языка в начале с en на nl, переведите шесть текстов и добавьте новый файл в оба списка — client_scripts и server_scripts — в fxmanifest.lua. Затем установите Config.Locale в nl, выполните refresh и перезапустите ресурс.

Уведомления

client/utils.lua отправляет каждое уведомление: ESX.ShowNotification на ESX, QBCore.Functions.Notify на QBCore, экспорт notify QBox на QBox и обычную ленту GTA для всего остального. Замените тело этой единственной функции, чтобы направлять сообщения в ваш собственный ресурс уведомлений.

Команды

Команда или клавиша	Что делает	Где задаётся
`/parrot`	Открывает меню Bird Companion, когда у вас есть птица	`Config.OpenMenuCommand`
U	То же, что и команда	`Config.MenuKey`