Installation
Basic installation instructions for this resource
1. Ensure all dependencies are installed
Please make sure all required dependencies are installed and started before continuing
2. Extract Resources
After downloading from keymaster, open the .zip file and open the first folder you see. there are two folders, one is named spoodyGunPlug, the other is named spoodyGunPlug_map. drag both folders into your resources.
3. Install Inventory Items
If you are NOT on ox-inventory, though you use a weight-based/limit-based inventory, execute the items-weight.sql or items-limit.sql into your items table in your SQL If your inventory requires you to install somewhere else, you may need to open the .sql file to be viewable, and manually insert all of it's data into your inventory
If you ARE on ox-inventory, simply execute the items-weight.sql into
your items table in your SQL.
After you've installed the items, restart your server twice and test in-game to ensure the inventory systems have properly initiated your items into your inventory-system
Our resource uses ESX.RegisterUseableItem to register items, please ensure your inventory system covers this bridge, or your item(s) in-game may not work properly.
4. Configure Role Methods
If you'd like to whitelist all items & black-markets in-game to special users, you may utilize jobs & Discord roles to do so.
💻 Discord Roles
In order to utilize Discord roles as a method, Badger_Discord_API is required. (Install it if you haven't already)
• First, set the Method to 'discord' via spoodyGunPlug/configuration.lua:23
• Second, set the MethodResource to whatever your Badger Discord API resource name is.
• Third, set your MethodID to whatever your Discord Role ID is -> learn more
Example 👇
Method = 'discord',
MethodID = 'discord_role_id', --- The ID of the method (job name, or Discord role ID)
MethodResource = 'Badger_Discord_API', --- Discord API Resource goes here (leave blank if not using Discord Roles)💼 Job Roles
If you'd like to utilize basic in-game job roles, ensure that the job you'd like to use is already installed into your server (via SQL, or wherever your job data may be)
• First, set the Method to 'job' via spoodyGunPlug/configuration:23
• Second, set the MethodResource to nothing 👉 ''
• Third, set your MethodID to whatever your job name is.
Example 👇
5. Configure Inventory Path
In order for all item images to properly load in the context menus, you need to make sure your inventory path to your images is properly configured. In order to do so, simply find your inventory in your server-files, and find the path to wherever all of your item images are. Examples 👇
Ox Inventory
ESX Inventory
6. Configure Resource
Configure the resource to your likings, though the resource is already pre-configured, there are things that require configuration, like rewards, job methods, as well as optional settings like timers and more.
Once completed, restart your server. Ensure spoodyGunPlugis started after all dependencies.
1. Ensure all dependencies are installed
Please make sure all required dependencies are installed and started before continuing
2. Extract Resources
After downloading from keymaster, open the .zip file and open the first folder you see. there are two folders, one is named spoodyGunPlug, the other is named spoodyGunPlug_map. drag both folders into your resources.
3. Install Inventory Items
If you are NOT on ox-inventory, though you use a weight-based/limit-based inventory, execute the items-weight.sql or items-limit.sql into your items table in your SQL If your inventory requires you to install somewhere else, you may need to open the .sql file to be viewable, and manually insert all of it's data into your inventory
If you use QB-Inventory, simply copy & paste all contents of the items-qb.txt into your items data file in your QB Core resource file
After you've installed the items, restart your server twice and test in-game to ensure the inventory systems have properly initiated your items into your inventory-system
Our resource uses QBCore.Functions.CreateUseableItem to register items, please ensure your inventory system covers this bridge, or your item(s) in-game may not work properly.
4. Configure Role Methods
If you'd like to whitelist all items & black-markets in-game to special users, you may utilize jobs & Discord roles to do so.
💻 Discord Roles
In order to utilize Discord roles as a method, Badger_Discord_API is required. (Install it if you haven't already)
• First, set the Method to 'discord' via spoodyGunPlug/configuration.lua:23
• Second, set the MethodResource to whatever your Badger Discord API resource name is.
• Third, set your MethodID to whatever your Discord Role ID is -> learn more
Example 👇
💼 Job Roles
If you'd like to utilize basic in-game job roles, ensure that the job you'd like to use is already installed into your server (via SQL, or wherever your job data may be)
• First, set the Method to 'job' via spoodyGunPlug/configuration:23
• Second, set the MethodResource to nothing 👉 ''
• Third, set your MethodID to whatever your job name is.
Example 👇
5. Configure Inventory Path
In order for all item images to properly load in the context menus, you need to make sure your inventory path to your images is properly configured. In order to do so, simply find your inventory in your server-files, and find the path to wherever all of your item images are. Examples 👇
Ox Inventory
QB Inventory
6. Configure Resource
Configure the resource to your likings, though the resource is already pre-configured, there are things that require configuration, like rewards, job methods, as well as optional settings like timers and more.
Once completed, restart your server. Ensure spoodyGunPlugis started after all dependencies.
Last updated