Installation
Five minutes. There is no SQL file of its own and no second resource: the only thing you add outside the folder is the bird items in your inventory.
Before you start
Section titled “Before you start”| You need | Why |
|---|---|
| ESX, QBCore or QBox, running | The birds are usable items, registered through your framework |
| Access to your inventory’s item list | Fourteen items have to exist there |
| Access to your inventory’s image folder | So the items have icons |
1. Put the folder in place
Section titled “1. Put the folder in place”Drop mic_parrots into your resources, for example inside resources/[mic]/. Keep the folder name as it is; the menu talks to the resource by its own name.
The nine custom birds are in the stream/ folder and their flight data is flight.meta. Both load themselves from the manifest; you do not move them anywhere.
2. Start it after your framework
Section titled “2. Start it after your framework”In server.cfg, put ensure mic_parrots below your framework (es_extended, qb-core or qbx_core) and below your inventory.
It worked when the server starts mic_parrots with no red lines under it.
3. Tell it which framework you run
Section titled “3. Tell it which framework you run”Open config.lua and set Config.Framework to one of:
| Value | For |
|---|---|
esx | ESX (this is the default) |
qb-core | QBCore |
qbox | QBox |
There is no auto-detection: this value decides how the items are registered and how notifications are shown.
4. The database
Section titled “4. The database”Nothing to import for the resource itself. On ESX with the default inventory the items live in the items table, so you add them there (next step).
5. Add the items
Section titled “5. Add the items”Each item name calls one bird. The item names are the left side of Config.BirdItems in config.lua.
| Item | Bird | Model |
|---|---|---|
crow | Crow | base game |
pigeon | Pigeon | base game |
seagull | Seagull | base game |
cormorant | Cormorant | base game |
chickenhawk | Chicken Hawk | base game |
macaw | Macaw | custom, streamed |
parrot | Parrot | custom, streamed |
falcon | Falcon | custom, streamed |
vulture | Vulture | custom, streamed |
eagle | Eagle | custom, streamed |
owl | Owl | custom, streamed |
hornbill | Hornbill | custom, streamed |
sparrow | Sparrow | custom, streamed |
warbler | Warbler | custom, streamed |
Where the ready-made definitions are: the readme.md file inside the resource has three blocks, one per inventory:
- ox_inventory — the block marked for
ox_inventory/data/items.lua. Paste it into that file. - QBCore — the block marked for
qb-core/shared/items.lua. Paste it into that file. - ESX — the block marked “ITEMS FOR ESX SQL”. Run it once against your database.
Images: all fourteen icons are in the inventory_images/ folder, named after the item (crow.png, eagle.png…). Copy them into your inventory’s image folder — for ox_inventory that is ox_inventory/web/images/, for qb-inventory qb-inventory/html/images/.
It worked when you can give yourself parrot and it shows in your inventory with its picture.
6. First test
Section titled “6. First test”Give yourself a bird and use it from the inventory.
It worked when your character whistles, a bird flies in from behind and lands on your right shoulder. Press U (or type /parrot) and the Bird Companion menu opens with Shoulder, Head, Dismiss and Follow. Dismiss sends it off and frees you to call another.
Before you open your city
Section titled “Before you open your city”Config.Frameworkmatches your server. A wrong value is the most common reason nothing happens.- All fourteen items exist, including
sparrow, and each one has its icon. Config.Localeis the language you want for the notifications.- U is free. If another script uses U, change
Config.MenuKey— see Customization.