Idle Anims

Idle Anims suggests animations based on the player's surroundings and current situation. Players can lean against walls, sit on benches, inspect an open engine bay, greet nearby players, dance in configured locations, and more.

{:links-list}

INSTALLATION

  1. Open the downloaded ZIP product file and copy the complete BigDaddy-IdleAnims resource folder into your server's resources folder. Use the folder containing fxmanifest.lua, not the outer source-project folder.
  2. Add your product key (get it here) to the settings.ini file.
  3. Customize settings.json if needed. The included settings provide a starting setup.
  4. Add ensure BigDaddy-IdleAnims to your server.cfg, then start or restart the resource.

DO NOT RENAME THE FOLDER.

If you change the name of the folder it will not function correctly, so leave the name as it is.

{:is-danger}

REQUIREMENTS

Idle Anims runs standalone. It does not require a framework, inventory, targeting system, or database.

HOW TO USE

  1. Stand still near a suitable object, surface, player, or configured location.
  2. Wait for the suggestion to appear.
  3. Press minus (-) to play the suggested animation.
  4. While the animation runs, the prompt changes to Stop and displays X.
  5. Press X, press the play key again, or move using WASD or a gamepad/joystick to cancel.

The prompt uses the player's current keyboard bindings. Players can change them under Settings > Key Bindings > FiveM using Idle Anims: play suggestion and Idle Anims: stop animation.

Movement input cancels even when the animation prevents the player from physically moving. Entering a vehicle, combat, death, ragdoll, and other incompatible states also cancel playback. Any attached animation tool is removed when playback stops.

Suggestions require an unarmed player who is available for an animation. They are hidden while driving, swimming, climbing, falling, aiming, using a scenario, or interacting with a focused NUI panel.

INCLUDED SUGGESTIONS

All 16 supplied entries are enabled by default. The list below follows their priority in settings.json; the first matching entry wins.

ID ACTION WHERE / WHEN
bench Sit down Face a supported bench within 1.8 metres. The supplied list contains 12 bench models.
bbq Barbeque Face prop_bbq_5 within 1.6 metres; attaches a spatula during playback.
bin Dig through the bin Face a supported bin within 1.3 metres.
engine Inspect vehicle Face an open bonnet or trunk, standing within 1.6 metres of that part. The vehicle must be stationary.
lean Lean Stand with your back close to a suitable wall.
bar Lean over Face a suitable counter or railing.
seat Sit down Stand with a suitable flat seating surface behind you.
unicorn Dance Within 13 metres of (115.6, -1289.0, 28.2).
tequilala Dance Within 10 metres of (-557.65, 285.32, 82.2).
bahamas Dance Within 10 metres of (-1386.73, -619.17, 30.8).
intimidate Intimidate Briefly after melee combat ends.
hurt Show pain Below the configured usable-health threshold.
cheer Cheer Face a burnout or sideways-moving vehicle within 15 metres.
greet Greet Face another player within 3 metres, subject to the greeting cooldown.
talk Talk Face another player within 3 metres.
idle Idle Stand still for 4 seconds when no earlier entry matches.

Surface suggestions depend on map collision and available clearance. Dance areas only define where suggestions appear; they do not install interiors or spawn map objects. Adjust their coordinates for your server's maps.

CONFIGURATION

Two files control the resource:

FILE PURPOSE
settings.ini Product key, ACE permissions, and diagnostic settings
settings.json Key defaults, suggestion timing, animation lists, props, and locations

Restart BigDaddy-IdleAnims after changing either file. Back up your customized files before installing an update.

SETTINGS.INI

SETTING DEFAULT DESCRIPTION
[licensing]
key1 Your product key This is where you put your product key
[settings]
UseAcePermissions false Restricts animation use to players with the configured ACE permission when enabled
AcePermission command ACE checked when UseAcePermissions=true
debug false Enables additional diagnostic output
DesyncKey provided used internally by the resource. Leave unchanged

SETTINGS.JSON

The main settings appear outside the Suggestions array.

SETTING DEFAULT DESCRIPTION
ShowPrompt true Displays the suggestion and Stop prompts. Turning this off does not disable the key bindings
PlayKey MINUS Initial keyboard binding for playing a suggestion
CancelKey X Initial keyboard binding for stopping an animation
ScanIntervalMs 200 Time between context checks. Valid range: 100 to 2000 milliseconds
SuggestionDelayMs 1000 How long a non-idle context must remain stable before its suggestion becomes available. Valid range: 0 to 10000 milliseconds
IdleDelayMs 4000 Stationary time before an idle suggestion becomes available. Must be zero or greater
CooldownMs 1000 Minimum wait after stopping an animation before another can start. Must be zero or greater
GreetCooldownMs 900000 Wait before suggesting another greeting to the same server player ID. Default is 15 minutes; tracked for the current resource session
InjuredHealthRatio 0.6 Health threshold for showPain. Must be greater than 0 and less than 1; 0.6 means below 60% of usable health, excluding GTA's 100-point health baseline
CancelControls [30, 31, 22, 23, 24, 25, 263, 264] Additional GTA control IDs that cancel playback. IDs must be integers from 0 to 360
Suggestions Included list Ordered list of animation suggestions

All settings ending in Ms use milliseconds: 1000 = 1 second, 4000 = 4 seconds, and 60000 = 1 minute.

Moving, turning, losing the context, or switching targets restarts the contextual suggestion delay. The idle suggestion uses IdleDelayMs without adding SuggestionDelayMs on top. The play key cannot start a suggestion before its delay has completed.

KEY BINDINGS

Changing PlayKey or CancelKey sets the initial binding for players who have not already saved one. Existing players must change their bindings in FiveM's key-binding settings.

{:is-warning}

MOVEMENT CANCELLATION

WASD and gamepad/joystick movement always cancel the animation, as does the cancel command. Removing movement IDs from CancelControls, or setting it to an empty array, does not disable this behavior.

{:is-warning}

CUSTOMIZING SETTINGS.JSON

COMPLETE SMALL CONFIGURATION EXAMPLE

This is a complete valid settings.json containing only one idle suggestion. It illustrates the file structure. Replacing your entire file with this example removes all other suggestions. To retain the included setup, edit the relevant fields or add entries to its existing Suggestions array instead.

{
  "ShowPrompt": true,
  "PlayKey": "MINUS",
  "CancelKey": "X",
  "ScanIntervalMs": 200,
  "SuggestionDelayMs": 1000,
  "IdleDelayMs": 4000,
  "CooldownMs": 1000,
  "GreetCooldownMs": 900000,
  "InjuredHealthRatio": 0.6,
  "CancelControls": [30, 31, 22, 23, 24, 25, 263, 264],
  "Suggestions": [
    {
      "Id": "idle",
      "Label": "idle",
      "Context": "idle",
      "Enabled": true,
      "Align": false,
      "Animations": [
        {
          "Dictionary": "rcmjosh1",
          "Clip": "idle",
          "Flags": 33,
          "DurationMs": -1
        }
      ]
    }
  ]
}

SUGGESTION SETTINGS

Each object inside Suggestions describes one situation and the animations available in that situation.

PROPERTY DEFAULT IF OMITTED DESCRIPTION
Id Required Unique identifier for this entry. Do not reuse an ID, even with different capitalization
Label Required Action text shown before playback. Choose wording that describes every animation in this entry
Context Required Detection type from the context table below
Enabled true Set to false to disable the entry without deleting it
Radius 1.6 Detection radius in metres for props, areas, social interactions, and vehicle searches. Must be greater than 0 and no more than 100
Models Empty list Object model names. Required and nonempty for prop entries
Center X/Y/Z all 0 World coordinates of an area. Set this explicitly for your location
Align false Uses calculated position and heading when playing the animation
HeadingOffset 0 Degrees added to the detected heading when alignment is enabled
Offset X/Y/Z all 0 Shared alignment offset added to the selected animation's offset
Animations Required Nonempty array of animation definitions

Disabled entries must still contain valid settings. To remove an unfinished entry from validation, remove the entire entry from the array.

AVAILABLE CONTEXTS

CONTEXT WHEN IT CAN SUGGEST AN ANIMATION
prop Player is near and facing an object listed in Models, with line of sight. The object must be stationary
area Player is within Radius metres of Center
lean A stationary wall or similar supporting surface is directly behind the player and aligned with their back
leanBar A stationary counter or railing is in front of the player, with support across their width and clearance above
sit A suitable flat surface is behind the player below their waist, with enough width and clearance
idle Player has been stationary for IdleDelayMs
intimidate Player has recently been in melee combat; available briefly after combat ends
showPain Player's usable health is below InjuredHealthRatio
inspectCar Player is facing and close to the open bonnet or trunk of a stationary vehicle
cheerBurnout Player is facing a nearby vehicle performing a burnout or moving sideways at speed
greet Player is facing a nearby, nearly stationary player they have not greeted within GreetCooldownMs
conversation Player is facing a nearby, nearly stationary player

Radius does not change the short surface probes used by lean, leanBar, or sit. Vehicle inspection also has an additional close-range check at the open bonnet/trunk, so increasing its search radius does not allow inspection from far away. Area radius is a three-dimensional distance, including height.

PRIORITY AND DISABLING SUGGESTIONS

The resource selects the first enabled matching entry in the array. Position specific props, surfaces, and locations before broad fallbacks such as idle.

To disable an entry, locate its Id and change its Enabled value to false. For example, disable the entry with Id set to hurt to remove the low-health suggestion.

To change a prompt's wording, edit Label. This does not change the animation itself. During playback the prompt displays Stop with the cancel binding.

If you create an animation that should take priority over an existing entry, move the whole suggestion object above that entry. Two matching entries are not combined into one animation list.

ANIMATION SETTINGS

PROPERTY DEFAULT IF OMITTED DESCRIPTION
Dictionary Required GTA animation dictionary containing the clip
Clip Required Animation clip name within that dictionary
Flags 1 GTA animation flag value. Keep the known working value supplied with your chosen animation; it affects playback and movement behavior
DurationMs -1 No explicit time limit when -1; a positive value limits playback to that many milliseconds. 0 is invalid. A non-looping clip can still finish naturally with -1
Offset X/Y/Z all 0 Adjustment for this individual animation when Align=true
Tool None Optional attached object definition, described below

To provide variations, add more complete animation objects inside the same Animations array. One is selected randomly each time the suggestion starts. These are alternatives, not a sequence.

Use dictionary and clip names from a known working animation. A scenario name, animation menu command, or display name is not a substitute for a dictionary and clip. Custom animations must be streamed and available before they can load.

ADDING A LOCATION

Add this entire object inside your existing Suggestions array. It adds a small dance area using a known animation. Change Id to a unique name and replace Center with the coordinates of your location.

{
  "Id": "custom_dance_area",
  "Label": "dance",
  "Context": "area",
  "Enabled": true,
  "Center": { "X": 115.6, "Y": -1289.0, "Z": 28.2 },
  "Radius": 5.0,
  "Align": false,
  "Animations": [
    {
      "Dictionary": "anim@amb@nightclub@mini@dance@dance_solo@male@var_b@",
      "Clip": "high_center_down",
      "Flags": 33,
      "DurationMs": -1
    }
  ]
}

With Align=false, players dance where they are standing. Place this entry above another dance area if their radii overlap and you want this entry to win.

ADDING A PROP INTERACTION

Add an entry like this to Suggestions. This example uses an existing bin model and a rummaging animation. It does not create the bin or give the player any items.

{
  "Id": "custom_bin",
  "Label": "dig through the bin",
  "Context": "prop",
  "Enabled": true,
  "Models": ["prop_bin_01a"],
  "Radius": 1.3,
  "Align": false,
  "Animations": [
    {
      "Dictionary": "mini@repair",
      "Clip": "fixing_a_ped",
      "Flags": 33,
      "DurationMs": -1,
      "Offset": { "X": 0.0, "Y": 0.0, "Z": 0.0 }
    }
  ]
}

This model is already supported by the included bin entry. Either edit that existing entry or put your custom entry above it. To cover more models with the same interaction, add their names to Models, separated by commas. Props must already exist in the world; this list does not spawn them.

ALIGNMENT, POSITION, AND HEADING

Use Align=true when the player must be positioned against a surface or object. With alignment disabled, Offset and HeadingOffset do not reposition or rotate the player.

The alignment origin depends on the context:

CONTEXT ALIGNMENT ORIGIN AND HEADING
prop Object origin and object heading
area Center and the player's current heading
lean / leanBar Detected surface position, player's current height, and heading derived from the surface direction
sit Detected seating surface and the player's current heading
Other contexts Player's current position and heading

HeadingOffset is added to that heading. The suggestion's Offset and the selected animation's Offset are then added together and rotated using the final heading:

AXIS DIRECTION
X Horizontal X offset, rotated by the final heading
Y Horizontal Y offset, rotated by the final heading
Z Up or down

Offsets are in metres. Heading is in degrees. Changing a position offset does not turn the player; use HeadingOffset for that.

For an existing bench setup, start by editing its current values. Adjust one axis at a time in small steps, such as 0.02 or 0.05, then restart and test. Use the suggestion-level offset to move every variant together, or an animation-level offset to correct only one pose.

ALIGNMENT LIMITS

Each position-offset component must be between -20 and 20. The final alignment target must also be within 3 metres of the player's starting position or playback is rejected. Larger offsets do not bypass that distance check.

Models have different origins and collision shapes. An offset that works for one bench may not work for another. Create separate prop entries when models need different alignment.

{:is-warning}

On normal cancellation, an aligned animation can return the player to their starting position and heading when they remain nearby and it is safe to do so.

ATTACHING AN OBJECT TO AN ANIMATION

Add Tool inside an individual animation object. This complete suggestion shows the structure using the included barbecue setup:

{
  "Id": "custom_barbecue",
  "Label": "barbeque",
  "Context": "prop",
  "Enabled": true,
  "Models": ["prop_bbq_5"],
  "Radius": 1.6,
  "Align": false,
  "Animations": [
    {
      "Dictionary": "amb@prop_human_bbq@male@idle_a",
      "Clip": "idle_b",
      "Flags": 33,
      "Tool": {
        "Model": "prop_fish_slice_01",
        "Bone": 28422,
        "Position": { "X": 0.0, "Y": 0.0, "Z": 0.0 },
        "Rotation": { "X": 0.0, "Y": 0.0, "Z": 0.0 }
      }
    }
  ]
}

The default configuration already includes a bbq entry. Edit it or place your replacement above it.

TOOL PROPERTY DEFAULT IF OMITTED DESCRIPTION
Model Required Model name of the object to attach. Must be a valid GTA or streamed model
Bone 28422 Ped bone ID used for attachment; this is a bone ID, not a bone index
Position X/Y/Z all 0 Attachment offset relative to the selected bone, in metres
Rotation X/Y/Z all 0 Attachment rotation, in degrees

Tool.Position uses bone-relative coordinates. It is separate from the suggestion and animation alignment offsets. Each position component must be between -20 and 20; rotation values must be finite numbers. Remove Tool entirely if the animation does not need an object.

The attached object is created for playback and deleted on cancellation or cleanup. It does not require or consume an inventory item. Use BigDaddy Attach Preview to help determine attachment positions and rotations for custom tools.

ACE PERMISSIONS

By default, UseAcePermissions=false allows all players to use the licensed resource.

To restrict use, enable ACE checking and choose a permission in settings.ini:

UseAcePermissions=true
AcePermission=bigdaddy.idleanims

Then grant that permission to the appropriate group in server.cfg:

add_ace group.admin bigdaddy.idleanims allow

Use your server's existing principal assignments to place players in that group. The server checks permission during startup synchronization. Restart the resource after changing its permission configuration. ACE permission does not bypass product licensing.

COMMANDS

COMMAND / CONTROL DESCRIPTION
Minus (-) Plays the available suggestion, or stops the current animation
X Stops the current animation
WASD / movement stick Cancels playback using the same cleanup as X
/bdidlecancel Stops the current animation without using a key binding
/bdidletoggle Enables or disables suggestions for the current player; disabling also stops playback

Minus and X are the initial bindings. Players can rebind them. The underlying play command is +bdidleanims. Suggestion toggles are session settings and are not saved across resource restarts.

INTEGRATION WITH OTHER RESOURCES

Client exports become available after successful license synchronization.

-- Disable suggestions and stop any current Idle Anims animation.
exports['BigDaddy-IdleAnims']:SetSuggestionsEnabled(false)

-- Allow suggestions again when your interaction finishes.
exports['BigDaddy-IdleAnims']:SetSuggestionsEnabled(true)

-- Check whether Idle Anims is loading or playing an animation.
local active = exports['BigDaddy-IdleAnims']:IsAnimationActive()

Disable suggestions while another resource needs control of the player's animation, then re-enable them on completion and cancellation. Check that the resource is started and its exports are available before calling them.

These are cosmetic animations. There are no inventory rewards, vehicle repairs, database records, or configurable custom-event callbacks.

PROMPT APPEARANCE

Use ShowPrompt to show or hide the prompt. Its colors, position, and sizing are in html/app.css.

The #prompt rule controls the panel. Keep html and body transparent and do not add color-scheme: dark to the page root, as it can produce a black full-screen NUI background. The prompt does not capture mouse or keyboard focus.

TROUBLESHOOTING

ISSUE WHAT TO CHECK
No suggestions appear Confirm the license validated, suggestions are enabled, and ACE allows the player if enabled. Stand still and unarmed in a matching context; close other NUI menus
A custom entry never appears Check its spelling, Enabled, conditions, and position in the array. An earlier matching entry takes priority
Resource reports a configuration error Check JSON syntax, duplicate IDs, context names, numeric ranges, and empty animation/model lists. Read the client F8 console for the affected setting
The label does not describe the animation Check every animation in that entry. Label applies to all randomly selected variants
Player faces the wrong way or sits too high/low Enable alignment when appropriate, check HeadingOffset, and tune the suggestion/animation offsets for that specific model
Animation or attached tool will not load Verify the dictionary, clip, and model names and any required streamed assets. Check the client F8 console
New keys do not take effect Existing players need to update their saved FiveM key bindings
Animation stops with very small stick movement Any nonzero movement-axis input cancels playback. Check the controller's calibration/deadzone if it sends input while untouched