Configuration

This page provides an explanation of all current configuration settings. It’s important to set up the script correctly, as incorrect configurations may lead to issues during use.

---

Config = {}

Config.ScrollType = 'pagination' -- Set this to 'pagination' for pagination (recommended) or 'scroll' for scroll.
Config.EmotePlayCommands = {'e', 'emote'} -- Commands to play an emote.
Config.WalkSetCommands = {'w', 'walk'} -- Commands to set a walk style.
Config.MenuKeybind = 'F3' -- List of keys here: https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/
Config.PtfxKeybind = {
    bind = 'E', -- List of keys here: https://docs.fivem.net/docs/game-references/input-mapper-parameter-ids/keyboard/
    text = 'E' -- The text of the keybind that will show up in the UI
}

Config.EnableAutoPtfx = true -- You can enable automated ptfx on emotes with the auto flag here.
Config.SharedEmotePlayCommands = {'nearby'} -- Commands to set a play a shared emote.
Config.UseTargetOnSharedAnims = false -- You can enable or disable the use of target on shared animations instead of sending it directly to the closest player.
Config.EnablePreviewAnimations = true -- You can enable or disable the right click on an animation to preview it.
Config.AllowEmotesOnVehicles = true -- Set this to false to disable playing animations while in a vehicle.
Config.CrouchKeybind = 'LCONTROL' -- Set this to false to disable crouch keybind (Config.CrouchKeybind = false).
Config.HandsUp = { -- Set this to false to disable handsup keybind (Config.HandsUp = false).
    keyBind = 'X',
    animation = {
        dict = 'random@mugging3',
        anim = 'handsup_standing_base'
    }
}

Config.EmoteMenuCategories = { -- Emote menu categories
    ['general'] = {
        index = 1,
        label = 'General',
        animationsType = 'all',
        type = 'emote',
        icon = 'list'
    },
    ['dances'] = {
        index = 2,
        label = 'Dances',
        animationsType = 'DanceEmotes',
        type = 'emote',
        icon = 'music'
    },
    ['walks'] = {
        index = 3,
        label = 'Walks',
        animationsType = 'Walks',
        type = 'walk',
        icon = 'person-walking'
    },
    ['expressions'] = {
        index = 4,
        label = 'Expressions',
        animationsType = 'Expressions',
        type = 'expression',
        icon = 'face-smile'
    },
    ['synchronized'] = {
        index = 5,
        label = 'Synchronized',
        animationsType = 'SynchronizedEmotes',
        type = 'shared',
        icon = 'people-arrows'
    },
    ['props'] = {
        index = 6,
        label = 'Props',
        animationsType = 'PropEmotes',
        type = 'emote',
        icon = 'box'
    },
    ['sits'] = {
        index = 7,
        label = 'Sits',
        animationsType = 'Sits',
        type = 'emote',
        icon = 'chair'
    },
    ['animals'] = {
        index = 8,
        label = 'Animals',
        animationsType = 'AnimalEmotes',
        type = 'emote',
        icon = 'paw'
    },
    ['favorites'] = {
        index = 9,
        label = 'Favorites',
        animationsType = 'Favorites',
        type = 'emote',
        icon = 'star'
    }
}