⚙️custom effects

With cr-effects you have the ability to use "custom" visual effects with something called timecycle. With timecycle there is a ton of already built in visual effects in fivem, but you can also make your own visual effects with the timecycle editor. On this page you will learn how to use these effects and create your own.

The built in effects from fivem

You can find all the diferent effects on this page: https://github.com/DurtyFree/gta-v-data-dumps/blob/master/timecycleModifiers.json Below is an example of how the list works. The name is what we are gonna focus on.

    "Name": "polluted",
    "DlcName": "basegame",
    "ModificationsCount": 14

To use the effect you will need to add the name of the effect in to the config under the custom section as the effectName as you can see below.

Custom = {
                enabled = true,
                effectName = "polluted",
                transition = 1000,
                strength = 100,
                time = 5000
            }

After that you need to set all the other variables to what you want.

And thats it, you can now use that effect with your chosen item.

Creating your own effects

To create your own visual effect you need to use something called the FxDK mode which comes with fivem as you install it. To find it you need to navigate to where you installed fivem. and open up FiveM - Cfx.re Development Kit (FxDK) as shown below.

Once opened you need to press the start button at the top left as shown below.

When you have done that you will start a "self hosted server", in this server you need to press F8 to open up the console, and in here you need to type timecycleeditor 1 to open up the tymecycle editor where you will create your effects.

When you have that opened you can start by giving your effect a name in the Name section at the top then click create (this is the name you will use to call it in cr-effects config/exports).

Once created you need to add your effects/variables.

To see your changes you need to click Apply as primary.

Search for a variable/effect and then click add. it will then popup as a variable in your effect, now you just need to play around with the values to get the effect that you want. You can add multiple effects/variables to get the effect that you want.

When you are happy with the effect you created you then click Generate XML.

Copy the content and head over to your cr-effects resource and navigate to the data folder and make a new XML file and name it what ever you like. Paste what you copied from the timecycle editor in to that file and save it.

And The effect is done. To use the effect see The built in effects from fivem It is the same principle.