Guides
Some guides to help you navigate the resource.
Last updated
Was this helpful?
Some guides to help you navigate the resource.
Last updated
Was this helpful?
Wondering how to get started? We recommend starting with our .
To get you started with commands and keybinds, we have an in-game help menu. This menu will be prompted the first time you use a consumable, and has to be manually opened after that if you wish to see it. You can disable this behaviour in the config, but it is recommended to keep enabled.
By default, you can access the menu via /consum:help.
To customize your personal experience and how you will experience certain aspects, you can configure your personal settings. The settings we allow you to personalize are rather basic and won't provide any advantage or disadvantage is any way.
As a server owner you can force certain behaviour, see LINK for more information on that.
By default, you can access this menu via /consum:settings.
To streamline the creation of items, we have constructed an item configurator UI. We advise you to use the Help Menu to get started. Below, you can find configuration warnings that would make a creation invalid.
When you create an item, you will be prompted warnings if any configuration issues arise. Below you can see an explanation for every issue.
There are two triggers for this:
The item doesn't exist in your server.
The item name is not provided during the validation.
This is one of the core flags required to be valid to create a draft. If you are receiving this error, make sure the item exists on your server.
This warning is relevant for job-created items, since all admin-created items are automatically whitelisted.
To ensure fair items are configured by jobs, an admin has to whitelist items that are allowed to configure. Read Whitelisted Items for more information on this.
To have "smart" items that can save the amount used, quality etc. an item has to be unique (non-stackable).
If you receive this warning, you need to go into your inventory and set the unique property to true, or stackable to false. What you need to do is based on the inventory you are using, if you need assistance, you can always create a ticket in our Discord.
This is an "internal" warning that would show up if you are trying to configure an item without providing a valid id in the data request and the item name is in use already. If this happens, create a ticket in our Discord as this would only be possible if a bug occurs.
This is an "internal" warning indicating that the data provided was completely invalid. If this happens, create a ticket in our Discord as this would only be possible if a bug occurs.
You haven't set an item type yet.
If you are using a direct consumption-based reward, you need to specify an amount the item will contain.
Job-restricted items are required to be ingredients. Set the use rewards to the required type and it will be resolved.
Note that if you are absolutely sure your configuration is correct and it still isn't working, the animation you are trying to input may be from a later Gta update. This is something you would have to discuss with the server owners.
Mostly same as Invalid Animation Combination, but this is configured in the accordion in the creator menu.
The props you have configured inside of the alignment menu are invalid. As Invalid Animation Combination suggests, it may be because of mismatching Gta versions.
If your item is already registered to be a usable directly within your inventory item configuration, it will prioritize it before us, this will restrict any of our functionality.
This is ox_inventory only at the time of making this.
In addition to the Item Creator, we constructed a creator for ingredients. It is far more basic than the item creator, and allows you to configure the ingredients to put into ingredient-based items.
We allow configured jobs to access the item creator to promote businesses making their own food using ingredients. To restrict what items can be configured, you can whitelist them via our menu.
When an admin configures an item, it is automatically whitelisted when created.
By default, you can access this menu via /consum:witems.
The resource offers a few world & player interactions to further extend immersion & functionality.
All keybinds for these interactions can be found in Help Menu.
Do remember that even if you are not using a targeting system, you must use our internal targeting key to express that you want to interact with the object. This was a design choice we made to avoid clumsy interactions.
Your consumables can be placed anywhere in the world and uses the first configured prop, or a default one of none exists.
Once placed, you can interact with it to pick it up. The indicator will turn green if you are in range.
You can transfer the item to other players by going into placement mode and attempting to place the item on a player. The outline will turn green to indicate you are able to transfer.
You can pur content into placed glasses if you are holding a drink. Just interact with it, and then use your scroll to decide the amount. At the end, press your interaction button and it will pour your drink.
You can max mix all drinks into here, both direct consumption-rewards and ingredient-based ones. You can also mix in one-hit items (ex. pills), even when the glass is full.
We offer two types of world items you can tailor towards your needs.
Enabling dynamic props is the best way to enjoy the resource, however, FiveM has strict limitations for network-synced props which makes this alternative less than ideal for large servers. We have implemented a lifetime manager to filter the active and relevant items to spawn, but we still recommend only enabling this on smaller servers.
When using dynamic props, they become an immersed part of your world. You can move them by pushing/shooting etc instead of being frozen like static ones.
Static items is the safer way to create world items. With this approach, a non-networked item is spawned at a set of coordinates that are synced to all clients. It larrgely works the same as dynamic items, but you can't move it in the world unless you pick it up or throw it.
Consumption haste & choking is an optional feature to enhance the realism. By changing the consumption haste you are able to consume quicker, but at a higher risk of choking.
By scrolling up/down, your consumption haste changes between 5 levels. Each level changes how fast you consume along with the risk of choking.
All of these options are available in the dropdown found top-right of your item configurator.
The animation combination (dictionary or clip) is invalid, these are configured in the alignments menu. Make sure that they are valid, you can verify this via ex. .
However, always double check that your props are valid first, ex. .
