Personalização

Quase tudo está em um único arquivo curto. O restante do código Lua também é aberto, permitindo que você altere o próprio comportamento se precisar.

Qual arquivo decide o quê

Arquivo ou pasta	O que ele decide	Aberto?
`config.lua`	Framework, idioma, tecla e comando do menu, a lista de aves	Aberto
`locales/*.lua`	Os textos de notificação, um arquivo por idioma	Aberto
`client/utils.lua`	Como uma notificação é exibida, por framework	Aberto
`client/client.lua`	A tecla do menu, o comando `/parrot` e o que cada botão do menu faz	Aberto
`client/bird_management.lua`	Como a ave chega voando, pousa, se move, segue e vai embora	Aberto
`server/server.lua`	Registra cada ave como item utilizável e mantém os outros jogadores sincronizados	Aberto
`html/`	O menu Bird Companion: `index.html`, `style.css`, `script.js` e seus ícones em `html/img/`	Arquivos simples
`stream/`	Os nove modelos de aves personalizados	Assets
`flight.meta`	Os dados de ped para as nove aves personalizadas	Dados
`inventory_images/`	Os quatorze ícones de itens	Assets
`readme.md`	Linhas prontas de itens para ox_inventory, QBCore e ESX	Referência

locales/main.lua é o único arquivo Lua protegido por escrow.

Configurações gerais — `config.lua`

Opção	O que faz	Padrão
`Config.Framework`	`esx`, `qb-core` ou `qbox`. Decide como os itens são registrados e as notificações exibidas	`esx`
`Config.Locale`	Idioma para notificações: `en`, `es`, `de`, `fr`, `it`, `pl`, `pt`, `ru`, `tr`	`en`
`Config.MenuKey`	Índice de controle do jogo que abre o menu. `303` é U	`303`
`Config.OpenMenuCommand`	Comando de chat que abre o menu	`parrot`
`Config.NoActiveBirdNotification`	Exibe uma mensagem quando alguém tenta abrir o menu sem uma ave ativa	`false`

Config.MenuKey é um número de controle do FiveM, não uma letra. A lista de números está na página de referência de controles do FiveM. Como ele é lido diretamente, os jogadores não podem redefini-lo em suas próprias configurações; o comando está sempre disponível como alternativa.

As aves — `Config.BirdItems`

Uma lista de nome do item → modelo de ped. Cada entrada se torna um item utilizável ao iniciar.

Item	Modelo
`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`

Adicionando uma ave

Adicione uma linha em Config.BirdItems com o nome do seu novo item e o modelo de ped que ele deve gerar.
Adicione o item ao seu inventário da mesma forma que os outros (veja Instalação) e dê um ícone a ele.
Uma ave do jogo base (qualquer modelo de ave a_c_…) não precisa de mais nada.
Uma ave personalizada precisa dos arquivos de modelo em stream/ e de sua própria entrada em flight.meta, ao lado das nove que já estão lá. Sem a entrada no flight.meta, o modelo carrega, mas não se comporta como uma ave.
Execute refresh e depois restart mic_parrots.

Removendo uma ave

Apague a linha dela em Config.BirdItems. O item deixará de fazer qualquer coisa; remova-o também do seu inventário para que ninguém fique com um item sem função.

O menu — `html/`

Os rótulos do menu (Bird Companion, Shoulder, Head, Dismiss, Follow, Close) estão escritos em html/index.html, e não nos arquivos de idioma. Traduza-os ou renomeie-os lá. As cores e o layout ficam em html/style.css, e os ícones dos botões são os arquivos PNG em html/img/.

O html/index.html também contém dois botões comentados: Dance e Sing. Eles não possuem nenhuma ação associada no Lua, portanto deixe-os comentados.

Esc ou o botão Close fecha o menu.

Idiomas

Nove idiomas vêm incluídos, um arquivo para cada em locales/: en, es, de, fr, it, pl, pt, ru, tr. Escolha um com Config.Locale.

Cada arquivo contém seis linhas: sem permissão, já possui uma ave, nenhuma ave no ombro, ave já está no ombro, ave já está na cabeça e você precisa de uma ave ativa para abrir o menu.

Para adicionar um idioma: copie locales/en.lua para um novo arquivo (por exemplo, locales/nl.lua), altere a chave do idioma no topo de en para nl, traduza os seis textos e adicione o novo arquivo em ambas as listas client_scripts e server_scripts no fxmanifest.lua. Em seguida, defina Config.Locale como nl, dê refresh e reinicie.

Notificações

O arquivo client/utils.lua envia todas as notificações: ESX.ShowNotification no ESX, QBCore.Functions.Notify no QBCore, a exportação de notificação do QBox no QBox e o feed padrão do GTA para qualquer outro caso. Substitua o corpo dessa única função para direcionar as mensagens para a sua própria resource de notificação.

Comandos

Comando ou tecla	O que faz	Definido em
`/parrot`	Abre o menu Bird Companion quando você tem uma ave ativa	`Config.OpenMenuCommand`
U	O mesmo que o comando	`Config.MenuKey`