NC Wings — Configuration guide
Every option of config.lua. After a change, restart the resource (ensure nc_wingstails) or the server.
Back to the guide: README.md.
1. Framework
| Option | What it does | Default |
|---|
Config.Framework | 'auto' = the first started of qbx_core, qb-core, es_extended, otherwise standalone. Force it with 'qbx', 'qb', 'esx', 'standalone'. Start nc_wingstails after the framework. The framework files are in bridge/framework/ and you can edit them. | 'auto' |
2. General
| Option | What it does | Default |
|---|
Config.Command | Admin command that opens the panel (assign / revoke). | 'wingstails' |
Config.ToggleCommand | Player command: without argument puts the wings on / off; with an animation id switches the animation (/wings fly). | 'wings' |
Config.ToggleKey | Fixed key for the toggle, for example 'F9'. '' = no key: every player binds it in FiveM Settings > Key Bindings. | '' |
Config.StreamDistance | Metres within which the wings of other players are shown; farther away they are removed. | 60.0 |
Config.Debug | Messages in the F8 and server consoles and the /wingspos command. Leave false on a live server. | false |
Config.RateLimit | Anti-spam: at most maxRequests actions every windowMs milliseconds per player (toggle, animation, assign, revoke). | { maxRequests = 5, windowMs = 2000 } |
3. Permissions — Config.Permission
Who can open the admin panel and assign / revoke. Checked on the server only. A player is allowed when at least one rule matches. /wings is not affected: every player can wear the wings assigned to them.
| Option | What it does | Default |
|---|
everyone | true = every player (the other rules are ignored). | false |
ace | ACE permission, for example add_ace group.admin nc_wingstails.use allow in server.cfg. '' = rule off. | 'nc_wingstails.use' |
groups | Framework groups (Qbox / QBCore: admin, god...; ESX: admin, superadmin...). | { 'admin' } |
jobs | Allowed jobs, for example { 'police' }. | { } |
identifiers | Allowed identifiers, for example { 'license:...', 'discord:...' }. | { } |
4. Wings — Config.Props
One entry = one wings and tail prop. The resource ships one prop (nc_wingstails_d) with 5 colours and 4 animations. A player has one pair at a time: a new assignment replaces the old one.
| Field | What it does |
|---|
id | Id saved in the database and used by the panel. |
label | Name shown in the panel, one text per language: { it = '...', en = '...', ... }. |
slot | 'back': worn on the back. |
model | Base model, used when a colour has no model of its own. |
bone | Ped bone the wings are attached to (24816 = upper spine). |
pos / rot | Offset in metres and rotation in degrees from the bone. The shipped values are tested in game: vector3(-0.1, 0.0, 0.0) and vector3(0.0, -90.0, 180.0). |
dict | Animation file name without extension (stream/anim@nc_wingtails_d.ycd). |
anims | Animations: id (used by /wings <id>), label, clip (name inside the file). |
defaultAnim | Animation used when the wings are put on. |
colors | Colours: id, label, model (the .ydr of that colour), swatch (two colours shown in the panel). |
effect | Particle effect, optional: a prop without this field has no effect. |
id | Clip |
|---|
idle | idle_clip |
fly | fly_clip |
hungry | hungry_clip |
listen | listen_idle_clip |
id | Model in stream/ |
|---|
originale | nc_wingstails_d |
dorato | nc_wingstails_dorato |
rosso_sangue | nc_wingstails_rosso_sangue |
blu_notte | nc_wingstails_blu_notte |
verde_smeraldo | nc_wingstails_verde_smeraldo |
The texture file nc_wingstails_d_tex.ytd and the model definitions nc_wingstails_d_ytyp.ytyp are shared by all 5 colours. To hide a colour from the panel, remove its row from colors.
| Field | What it does | Default |
|---|
enabled | false = no fire. | true |
dict | Effect file without extension (stream/red_effect.ypt). | 'red_effect' |
name | Effect name inside the file. | 'red_fire' |
bones | Bones of the prop the fire starts on. | { 'nc_wingstails_tail_28' } |
offset / rot | Offset and rotation from the bone. | vector3(0.0, 0.0, 0.0) |
scale | Size of the fire. | 0.05 |
If you use a ped where the wings sit wrong: set Config.Debug = true, restart the resource, put the wings on with /wings, then try values with /wingspos x y z rx ry rz [bone]. The F8 console prints the line to paste in pos / rot / bone. Put Config.Debug = false back when you are done.
5. Language
| Option | What it does | Default |
|---|
Config.Locale | 'it', 'en', 'de', 'fr', 'es', 'pt', 'zh', 'ja', 'ko'. Texts are in locales/<language>.lua; an unknown language uses English. With 'zh', 'ja', 'ko' the key name in the FiveM settings stays in English. | 'en' |
6. Database
Table nc_wingstails_assigned, created by itself at start (same text as sql/install.sql). One row per character:
| Column | Content |
|---|
owner | Character id (primary key). |
prop_id | Assigned wings. |
color_id | Assigned colour. |
anim_id | Saved animation. |
worn | 1 = worn, put back on at character load. |
assigned_by | Admin who assigned them. |
assigned_at | Date of the assignment. |
The full guide in 9 languages is also in the resource's docs/ folder.
