Personalizacja

Prawie wszystko znajduje się w jednym krótkim pliku. Pozostałe pliki Lua również są otwarte, więc w razie potrzeby możesz zmienić samo zachowanie skryptu.

Który plik za co odpowiada

Plik lub folder	Za co odpowiada	Otwarty?
`config.lua`	Framework, język, klawisz i komenda menu, lista ptaków	Otwarty
`locales/*.lua`	Teksty powiadomień, po jednym pliku na język	Otwarty
`client/utils.lua`	Sposób wyświetlania powiadomień zależnie od frameworka	Otwarty
`client/client.lua`	Klawisz menu, komenda `/parrot` oraz działanie poszczególnych przycisków menu	Otwarty
`client/bird_management.lua`	Sposób, w jaki ptak nadlatuje, ląduje, przemieszcza się, podąża i odlatuje	Otwarty
`server/server.lua`	Rejestruje każdego ptaka jako używalny przedmiot i synchronizuje go z innymi graczami	Otwarty
`html/`	Menu Bird Companion: `index.html`, `style.css`, `script.js` oraz ikony w `html/img/`	Zwykłe pliki
`stream/`	Dziewięć niestandardowych modeli ptaków	Assety
`flight.meta`	Dane pedów dla dziewięciu niestandardowych ptaków	Dane
`inventory_images/`	Czternaście ikon przedmiotów	Assety
`readme.md`	Gotowe wpisy przedmiotów dla ox_inventory, QBCore oraz ESX	Dokumentacja

locales/main.lua to jedyny plik Lua objęty ochroną escrow.

Ustawienia ogólne — `config.lua`

Opcja	Co robi	Domyślnie
`Config.Framework`	`esx`, `qb-core` lub `qbox`. Decyduje o sposobie rejestracji przedmiotów i pokazie powiadomień	`esx`
`Config.Locale`	Język powiadomień: `en`, `es`, `de`, `fr`, `it`, `pl`, `pt`, `ru`, `tr`	`en`
`Config.MenuKey`	Indeks kontrolki gry otwierającej menu. `303` to klawisz U	`303`
`Config.OpenMenuCommand`	Komenda czatu otwierająca menu	`parrot`
`Config.NoActiveBirdNotification`	Wyświetla komunikat, gdy ktoś próbuje otworzyć menu bez przywołanego ptaka	`false`

Config.MenuKey to numer kontrolki FiveM, a nie litera. Lista numerów znajduje się na stronie dokumentacji kontrolek FiveM. Ponieważ wartość ta jest odczytywana bezpośrednio, gracze nie mogą zmienić przypisania klawisza we własnych ustawieniach; alternatywą jest zawsze komenda czatu.

Ptaki — `Config.BirdItems`

Lista powiązań nazwa przedmiotu → model peda. Każdy wpis staje się używalnym przedmiotem przy starcie zasobu.

Przedmiot	Model
`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`

Dodawanie ptaka

Dodaj linię w Config.BirdItems z nazwą nowego przedmiotu oraz modelem peda, który ma się pojawiać.
Dodaj przedmiot do swojego ekwipunku w taki sam sposób jak pozostałe (zobacz Instalacja) i przypisz mu ikonę.
Ptak z podstawowej wersji gry (dowolny model ptaka a_c_…) nie wymaga niczego więcej.
Niestandardowy ptak wymaga plików modelu w folderze stream/ oraz własnego wpisu w flight.meta, obok dziewięciu już tam obecnych. Bez wpisu w flight.meta model się załaduje, ale nie będzie zachowywał się jak ptak.
Wpisz refresh, a następnie restart mic_parrots.

Usuwanie ptaka

Usuń jego linię z Config.BirdItems. Przedmiot przestanie cokolwiek robić; usuń go również ze swojego ekwipunku, aby nikt nie został z bezużytecznym przedmiotem.

Menu — `html/`

Etykiety w menu (Bird Companion, Shoulder, Head, Dismiss, Follow, Close) są zapisane w pliku html/index.html, a nie w plikach językowych. Przetłumacz je lub zmień ich nazwy bezpośrednio tam. Kolory i układ znajdują się w html/style.css, a ikony przycisków to pliki PNG w html/img/.

Plik html/index.html zawiera również dwa zakomentowane przyciski: Dance i Sing. Nie mają one przypisanej żadnej akcji w kodzie Lua, więc zostaw je zakomentowane.

Klawisz Esc lub przycisk Close zamyka menu.

Języki

W zestawie znajduje się dziewięć języków, po jednym pliku w folderze locales/: en, es, de, fr, it, pl, pt, ru, tr. Wybierz odpowiedni za pomocą Config.Locale.

Każdy plik zawiera sześć linii: brak uprawnień, masz już ptaka, brak ptaka na ramieniu, ptak jest już na ramieniu, ptak jest już na głowie oraz informację, że potrzebujesz aktywnego ptaka, aby otworzyć menu.

Aby dodać nowy język: skopiuj locales/en.lua do nowego pliku (na przykład locales/nl.lua), zmień klucz języka na górze z en na nl, przetłumacz sześć tekstów i dodaj nowy plik do obu list client_scripts oraz server_scripts w fxmanifest.lua. Następnie ustaw Config.Locale na nl, wpisz refresh i zrestartuj zasób.

Powiadomienia

Plik client/utils.lua odpowiada za wysyłanie każdego powiadomienia: ESX.ShowNotification na ESX, QBCore.Functions.Notify na QBCore, eksport powiadomień QBox na QBox oraz standardowy komunikat GTA w pozostałych przypadkach. Zastąp zawartość tej jednej funkcji, aby przekierować komunikaty do własnego zasobu powiadomień.

Komendy

Komenda lub klawisz	Co robi	Ustawiane w
`/parrot`	Otwiera menu Bird Companion, gdy masz przywołanego ptaka	`Config.OpenMenuCommand`
U	Działa tak samo jak komenda	`Config.MenuKey`