Poggy Badges

Overview#

Players with a listed job and grade can pin a badge prop to their chest, or an armband to their arm. They place it with a live editor and save the spot as a named preset, one per outfit. Show Badge plays a pocket-watch style animation with the badge in hand and flashes the badge picture, the character's name and your server name on the screens of players close by.

• Job and grade locked. Each job and grade gets its own badge picture and prop. Nobody else can open the editor.
• Live 3D editor with sliders for position and rotation. The badge moves as you drag.
• Bone picker: collar, chest, stomach, waist or hip, or either upper arm for armbands.
• Size slider for props that come in several sizes, so an armband fits a bare arm or a thick coat.
• Presets saved per character in the database.
• Any prop model: the five stock game badges work out of the box, and streamed packs work too. Packs that face the wrong way get a rotation override.
• Ready for Poggy Badge Props: the flash pictures for all 37 badges and five armbands in the pack are included, and its armbands start on the arm by themselves.
• A grade can hold up a different prop than it wears, so a medic with an armband shows a medic's badge.

Requirements#

Installation#

1. Download poggy_badge from your Cfx portal and put the folder in your server's resources folder.
2. In server.cfg, start it after oxmysql and poggy_core. If you own Poggy Badge Props, start the pack before Poggy Badges:

   ensure oxmysql
   ensure poggy_core
   ensure poggy_badge_props   # only if you have the pack
   ensure poggy_badge

3. Restart the server.
4. Check the badge sets match your job names (see Configuration).

The preset table (poggy_badge_presets) is created for you when the script starts. There is nothing to import. If you manage the database yourself, set PoggyCoreConfig.Sql.AutoInstall = false in poggy_core's config and import sql/install.sql.

Configuration#

Every setting can be changed in game in the /poggy settings hub under Poggy Badge, or by hand in config.lua. Restart the script after a change. The hub has two help pages: Adding a badge for a job and Fixing badge placement and rotation.

General

Starting position

These only decide where a new badge starts. Players move it from there with the editor.

Bones you can use: SKEL_Spine5 collar, SKEL_Spine4 upper chest, SKEL_Spine3 mid chest, SKEL_Spine2 lower chest, SKEL_Spine1 stomach, SKEL_Spine0 waist, SKEL_SpineRoot hip, SKEL_L_UpperArm and SKEL_R_UpperArm for armbands.

Badge sets (Config.badges)

Each set gives one or more jobs a badge per grade. In the hub: Badges → Badge sets.

{
    jobs = { "sheriff" },
    grades = {
        [0] = { badge = "sheriff", prop = "s_badgesherif01x", useName = true, useServerName = false },
        [1] = { badge = "sheriff", prop = "s_badgesherif01x", useName = true, useServerName = false },
    },
},

The shipped sets cover sheriff, deputy, police / Police, marshal / usmarshal and pinkerton, grades 0 to 5, with the stock game badges.

Stock badge props

Badge pictures

The flash pictures live in ui/images/. To add your own, drop a .png in that folder and use its name without .png as badge. Shipped pictures:

• Sheriff and deputy stars: sheriff, bronzebadge, silverbadge, goldbadge
• Marshal: marshal, bronzemarshal, silvermarshal, goldmarshal, federal
• Police: police, bronzepolice, silverpolice, goldpolice
• Detective: bronzedetective, silverdetective, golddetective
• Agency and senior: pinkerton, specialagent, presidentbadge
• Medical and cavalry: doctorbadge, cavalrybadge
• One for every prop in Poggy Badge Props, named poggy_ plus the badge's name, for example poggy_sheriff or poggy_armband_medic.

Commands#

The /badge name can be changed with Config.command. /bprop is fixed.

Permissions#

/badge needs no ACE. It is gated by job and grade only: the server checks the character's job and grade against the badge sets each time the editor opens and before every Show Badge.

/bprop needs the ACE command, which group.admin has on most servers. To grant it:

add_ace group.admin command allow

Using it in game#

1. Type /badge. The editor opens with your badge on its starting spot.
2. Move the sliders until it sits right. Pick another bone from the list if you want it lower, or on an arm.
3. For an armband, move the Size slider until it fits your outfit.
4. Type a name and click Save. Next time, click the preset to load it. Save one per outfit.
5. Click Show Badge to close the editor and show your badge to nearby players.

Rotation values that are whole numbers are nudged by 0.1, because the game resets an axis set to a whole number. You will not see a difference.

Troubleshooting#

"You don't have a badge for your current job/rank."

The character's job is not in any set, or their grade has no entry. Job names are case-sensitive. Turn on Debug output and type /badge: the server console shows the job and grade it read.

The badge faces the wrong way

Custom props often need a different rotation. Add their name prefix to Rotation overrides by prop name (Config.prefixRotations) with a rotation that faces forward.

The badge prop does not appear

Check the prop name. A streamed prop needs its pack running and started before Poggy Badges. The F8 console prints Failed to load model when a model is wrong.

Presets do not save

Presets are saved per character. Make sure a character is loaded and oxmysql is running.

Changing the flash duration does nothing

This version always shows the flash for 5 seconds. Show animation hold time does work: it sets how long the badge is held up.

An armband wearer holds up the armband

Set Prop held up by Show Badge (showProp) on that grade to a badge model, for example p_poggy_badge_doctor. The armband stays on the arm; only the prop in the hand changes.

Updating#

poggy_core's updater keeps it up to date, and your config.lua settings are kept: see Updates. New database columns are added when the script starts; existing presets keep working (presets from before the bone picker use the collar).

If you added your own pictures to ui/images/, keep a copy of them before updating.