search

alberttheprince / rpemotes-reborn

Community driven FiveM emote menu with human, animal, and prop support.
GNU General Public License v3.0
52 stars 34 forks source link

readme

image

Rpemotes-reborn is a community-driven FiveM emote menu allowing players to express themselves in roleplay with custom animations, countless facial expressions, walk styles, and props.

Rpemotes-reborn is free, and will always be free: accept no substitutes or reproductions from scummy people reselling other's hard work against agreements made with creators. We're committed to the open-source community and the dozens of contributors who put hard work into rpemotes to provide the community with free emotes and props.

Want to help support them? Check out our credits section at the bottom of the Readme and support those creators!

Interested in joining our community? You can find our Discord here.

Features πŸ› οΈ

Available in the following languages:

Albanian, Brazilian Portuguese, Chinese (Simplified), Chinese (Traditional), Czech, Danish, Dutch, English, Finnish, French, German, Greek, Hungarian, Indonesian, Italian, Lithuanian, Norwegian, Persian, Polish, Romanian, Russian, Serbian, Sinhala, Slovenian, Spanish, Swedish, Turkish, Vietnamese

Languages can be selected and/or added in the config.lua.

All languages were translated or contributed by the FiveM community, with the odd exception of using Google Translate.

If you find any incorrect translations or would like to add more languages, please make a pull request with the corrections.

Header

To edit the header, find the image in the main directory of rpemotes-reborn and edit the image in your program of choice. The image dimensions are 512 x 128.

Do not change the name of the image file.

Example Banner: image

Note for users of older versions of rpemotes: Previously, the banner was hosted through a web link on an image hosting website. Due to various image hosting sites dealing with large amounts of traffic from FiveM, they cut off access to FiveM.

Exports and Documentation

A partial archive of the original RP Emotes docs can be found here

When using our emote menu with other scripts, using the TriggerEvent('animations:client:EmoteCommandStart won't do anything because the events do not exist. These have simply been replaced with the following exports:

Note for legacy use of rpemotes: if you have resources dependent on or currently using exports from rpemotes, rename rpemotes-reborn's folder to rpemotes to maintain functionality. Or, rename all exports from exports["rpemotes"] to exports["rpemotes-reborn"]

exports["rpemotes-reborn"]:EmoteCommandStart(emoteName, textureVariation)
exports["rpemotes-reborn"]:EmoteCancel(forceCancel) – forceCancel is optional
exports["rpemotes-reborn"]:CanCancelEmote(state)
exports["rpemotes-reborn"]:IsPlayerCrouched()
exports["rpemotes-reborn"]:IsPlayerProne()
exports["rpemotes-reborn"]:IsPlayerCrawling()
exports["rpemotes-reborn"]:IsPlayerPointing()
exports["rpemotes-reborn"]:IsPlayerInAnim() -- returns current animation name or nil
exports["rpemotes-reborn"]:IsPlayerInHandsUp()
exports["rpemotes-reborn"]:toggleWalkstyle(bool, message) -- bool to allow the user to change their walkstyle in the menu or not / message to show the user (optional, default is :"You are unable to change your walking style right now.")"
exports["rpemotes-reborn"]:toggleBinoculars()
exports["rpemotes-reborn"]:toggleNewscam()
exports["rpemotes-reborn"]:getWalkstyle() -- Gets walk style of player, used to detect certain walk. useful for applying effects while doing certain walks like tripping or other "funny" effects.

Having issues with players using emotes when/where they're not supposed to? Use the following where you need. This would be somewhere like if you want to disable emotes in jail or when someone is handcuffed/escorted:

LocalPlayer.state:set('canEmote', false, true) -- stops emoting
LocalPlayer.state:set('canEmote', true, true) -- allows emoting

Menu Keybind πŸŽ›οΈ

The keybind uses RegisterKeyMapping. By default the configured keybind in the initial config.lua will be the default key, however once the keybind is set for a user it'll remain and can be changed in the users settings under Esc > settings > keybinds > fivem.

Menu key:

COMMAND: ACTION:
F4 Open / Close RPEmotes menu

Server owners can change this in the config.lua.

Alternatively, the player base can set their menu keybind to open rpemotes-reborn

Esc > settings > keybinds > fivem

Keybinds and SQL πŸŽ›οΈ

To use the SQL features, install the latest version of the oxmysql resource and enable the setting in config.lua

SqlKeybinding = false,

If you do not want to use the SQL features keep the oxmysql region in fxmanifest.lua commented out.

Alternatively, you can use the keybind command that comes with FiveM without having to use SQL, by entering the following into F8:

bind keyboard "Yourbutton" "e youremote". To remove the keybind, type "unbind keyboard "Yourbutton".

Menu Customization

In theconfig.lua file, server owners can set the MenuTitle or simply leave it blank. Ideally, this should be 11 characters or less without any spaces. You can also set the font and decide whether or not you want an outline and MenuPosition. The available fonts are as follows:

    -- 0 : Chalet London
    -- 1 : House Script
    -- 2 : Monospace
    -- 4 : Chalet Comprime Cologne
    -- 7 : Pricedown

Additional customizations can be found in the config. Please note due to limitations by Imgur and Discord; images can not be directly linked from either platform. You may link directly to an image from the forums, or just leave it blank.

Increments

Pressing 'LEFT ALT' on the keyboard allows players to scroll through the menu one by one, or by 10.

Alternatively, players can use the SHARE button on an Xbox controller or OPTIONS button on a Playstation controller.

Ragdoll πŸ₯΄

Finger Pointing & Hands Up πŸ‘†

Once enabled, players can press B on the keyboard to enable standalone finger pointing, and Y to put their hands up, without the need for unnecessary frameworks or "small resources".

Much like everything else in the menu, server owners can change these keybinds to their own preferences.

COMMAND: ACTION:
B Toggle Finger Pointing
Y Toggle Hands Up
/pointing Toggle Finger Pointing
/handsup Toggle Hands Up

Crouching & Crawling

Crouching:

RIGHT CONTROL. Players can move forward, back, left, and right as well as turn around. Press SPACEBAR to switch from stomach to back. Pressing the RIGHT CONTROL key while running will have the player "dive into" a crouching animation.

Crawling:

Server owners can opt in to either overriding the stealth/action animation when pressing the LEFT CONTROL keybind or have players tap LEFT CONTROL twice to switch from stealth to crouch (when enabled in the config.lua file)

Chat Commands

COMMAND: ACTION:
LEFT CONTROL Toggle Crouching On / Off
RIGHT CONTROL Toggle Crawling On / Off
/crouch Toggle Crouching On / Off
/crawl Toggle Crawling On / Off

Moods & Walkstyles πŸ˜œπŸšΆβ€β™‚οΈ

Moods and walk styles can be set from the menu. These will save to your character and reapply when exiting a vehicle, or loading back into the server as they are saved via client-side KVP.

COMMAND: ACTION:
F4 Opens RPEmotes menu
/walks See A List Of Walkstyles In Chat
/moods See A List Of Walkstyles In Chat
/reset mood Remove preferred mood and set default
/reset walk Remove last walkstyle and set default

Having problems with users "abusing" certain walk styles? rpemotes-reborn checks if a user has an "abusable" walk style saved and clears it when a player joins. Alternatively, you can use a resource like rpemotes-punishment to trip players abusing these emotes.

Just want to remove them? Delete the following walk styles from Animationlist.lua:

Bigfoot, Hurry, Hurry2, Hurry3, Flee, Flee2, Flee3, Flee4, and Flee5

No Idle Cam πŸ“·

No Idle Cam allows players to disable the idle camera animation on foot and in vehicle, making RP scenarios, streaming on Twitch, or just general gameplay just a little more enjoyable.

COMMAND: ACTION:
/Idlecamon deactivates the native
/idlecamoff enables the native

Binoculars πŸ‘€

COMMAND: ACTION:
/binoculars starts the binoculars
L ALT Toggle between night, heat and normal visions
G Show or hide the instructions
BACKSPACE Exit the binoculars

News Camera

COMMAND: ACTION:
/newscam starts the News Camera
H Edit Text
L ALT Toggle between vision modes
G Show or hide the instructions
BACKSPACE Exit News Camera

Favorite Emote

Players can search for an emote (so long as search is enabled) and press LEFT SHIFT and CAPLOCKS on their keyboard to add it to their 'Favorites'. Pressing CAPLOCKS will toggle the emote.

Alternatively, you can use the 🌟 Favorite menu to find an emote and press enter.

Exit Emotes

Exit Emotes are used to make cancelling an animation more smoother and dynamic, such as getting up off a chair or throwing a cigarette out instead of dropping it.

You can add your own Exit Emotes under AnimationListCustom.lua's new CustomDP.Exits = {} array.

Below is an example of how this would look:

    },
    ["sit"] = {
        "anim@amb@business@bgen@bgen_no_work@",
        "sit_phone_phoneputdown_idle_nowork",
        "Sit",
        AnimationOptions = {
            EmoteLoop = true,
            ExitEmote = "getup",
            ExitEmoteType = "Exits"
        }
    },

The ExitEmote calls for the 'getup' emote, which is noted as the following:

["getup"] = {
        "get_up@sat_on_floor@to_stand",
        "getup_0",
        "Get Up",
        AnimationOptions = {
            EmoteDuration = 2000
        }
    }
}

Adult Emotes πŸ”ž

Adult Emotes can be hidden from the menu by setting AdultEmotesDisabled to true in the config.lua file.

This will completely conceal the emotes from the lists (Emotes, Shared Emotes, etc) at startup making them unusable.

The emotes that are concealed, are the ones flagged in the animation list with AdultAnimation. You can see how it is done with fspose.

Alternatively, you can also hide animal emotes.

QB-Core βš™οΈ

QBCore integration to match their fork of dpemotes

If you’re using qb-core, you can now set

Framework = "qb-core",

in the config file, otherwise, leave it as

Framework = false,

You may need to alter some code within qb-core to work with RPEmotes.

Prop Extractor ↔️

Many people have expressed concerns over anticheat scripts kicking or banning their community members due to the fact RPEmotes uses props and anticheats detecting said props being spawned.

To make server owners' jobs a little easier, we have added a prop extractor command that you can enter into the server console which will automate a file inside the RPEmotes resource folder appropriately named, prop_list.lua.

Command:

emoteextract


Available output formats:
1 - 'prop_name',
2 - "prop_name",
3 - prop_name

Command usage example: emoteextract 1

Installation Instructions βš™οΈ:

Onesync Infinity is required for the particle effects to work as intended This can be done via txadmin or your localhost .bat file.**

For localhost servers, comment out onesync from your server.cfg and add the following to your .bat file:


+set onesync on +set onesync_enableInfinity 1 +set onesync_enableBeyond 1 +set onesync_population true

You can put this before your gamebuild enforcement, aka +set sv_enforceGameBuild XXXX

Alternatively, you can use the keybind command that comes with FiveM without having the SQL, by entering the following into F8:

bind keyboard "Yourbutton" "e youremote". To remove the keybind, type "unbind keyboard "Yourbutton".

Shared emotes πŸ‘©πŸ»β€β€οΈβ€πŸ’‹β€πŸ‘¨πŸΌ

Emotes will work with either SyncOffset or Attachto.

If it is with SyncOffsetFront or SyncOffsetSide, then the offset used is the one of the emote the player started.

For example, if player one starts the emote handshake which has SyncOffsetFront, then player one will have the SyncOffsetFront but not the other player.

Special case, if both emote have the Attachto then only the player who started the emote will be attached.

You can find a list of ped bones to attach the other player here: Ped Bones or alternatively, if the link is down for some reason, you can check here

Using the websites provided above, enter the bone ID, ie 1356 and not 111, which is the Bone Index.

Understandably, this can be confusing for some people. We suggest using the Attachto approach.

Particle Effects πŸ’¨

REQUIRES ONESYNC INFINITY

Particle effects can be found using the DurtyFree GTA V Dump. You will need to add the particle asset, name, and placement. Placement is done via XYZ, Pitch, Roll, Yaw, and scale.

Onesync is required for them to work across all clients.

PtfxPlacement = {
    -0.15, -- X
    -0.35, -- Y
     0.0, -- Z
     0.0, -- ROTATION X
     90.0, -- ROTATION Y
     180.0, -- ROTATION Z
       1.0 -- SCALE
},

By default, the main prop will share its coordinates with the particle effect, so just put 0.0 for the particle effects and you will be good to go.

If no prop is used in the animation or you require the particle effect to be in a different location, use PtfxNoProp = true, and 0.0 will 9/10 times be the human peds' stomach; you can then offset your coordinates based on that with the first 3 entries being XYZ, and the last 3 being rotation XYZ.

Alternatively, you can use the PtfxBone = AnimationOption to attach the PTFX to the ped's bone, similarly to how you attach props.

Using Menyoo, spawn down a tennis ball and attach it to a human, by default menyoo will attach it to the SKEL_ROOT bone (stomach), so from that, what we can do is either offset the coordinates, say, up to the human ped's mouth, or change the bone altogether. Once we've got it correct, we can transfer those coordinates over to RPEmotes, and tah dah, we have our Ptfx Placement.

Note that ptfxwait = is in ms, so if you'd like a particle to last for 30 seconds, it should be ptfxwait = 30000.

Adding Your Own Animations βš™οΈ

Because the menu gets updated frequently, the files get overwritten. To avoid this, you can add your own / downloaded animation files (.ycd) inside of a newly created folder, give it a name, and place it in the rpemotes\stream\[Custom Emotes] folder.

Add your animation code to the AnimationListCustom.lua and make a backup of this file and call it BackUpAnimationListCustom.lua.

Whenever an update is released, rename BackUpAnimationListCustom.lua to AnimationListCustom.lua, click yes to overwrite, and you're good to go.

Note that AnimationListCustom.lua and BackUpAnimationListCustom.lua files from versions prior to version 1.5.0 are not compatible with version 1.5.0, and files from version 1.5.0 are not backwards compatible with versions prior to version 1.5.0. To retain any custom animation code from previous versions, copy over any customizations into the AnimationListCustom.lua file that is included in the current version.

It is also a good idea to keep a backup of your config file. Below is an example:

Credits 🀝

All custom animations and props were added with permission from the creators.

All animation creators have specifically asked that their content remain free and that the RPEmotes team and community do not try to profit from them, claim them as their own, or reupload them anywhere else.

A huge thank you the following people for their amazing contributions to the menu: