F.A.Q

Default 0.00 If you are not in any hunting area.

If you are in a hunting area 0.01 (Constant)

It works with a default value of 0.00

When the areas are completely filled with animals and actively hunted, it varies between 0.00 and 0.02. The server was tested under load with 400 real players.

• For this go to wais-hunting/config.lua.
• Find the variable [“required”] = false and change it to true.
• This way, only people with this job will be able to do the job.

• For this go to wais-hunting/config.lua.
• ✔️ Change the Ped Model
  • Edit the "model" field and replace it with any ped model name you want.
  • ["model"] = "mp_m_exarmy_01",
• ✔️ Change the Ped Location
  • Update the "coords" value with the new position (x, y, z, heading).

• For this go to wais-hunting/config.lua.
• To create a new level, all you need to do is copy one of the lines from the Config.Levels[“levels”] list, paste it below, and edit the three fields:
• xp: The total experience points required to reach this level.
• level: The player's level number.
• multiplier: This level's special reward multiplier.

• The Multiplier applies an additional multiplier to the rewards the player receives upon reaching that level.
• This multiplier directly affects money, XP, or other rewards.

The Config.Commands section defines all the usable commands for the hunting system.
Each command has three main properties:

• command → The actual command players will type in chat.
• description → A short explanation of what the command does.
• permission → Who is allowed to use the command.

If permission = nil, anyone can use the command.
If permission = "group.admin", only admins (or the group you configured) can use it.

• For this go to wais-hunting/config.lua.
• Find the [“knife”] table within the Config.Skinning table.
• Replace the “WEAPON_KNIFE” item within [“name”] with the name of the knife you want.
• Change the false value of the [“must”] = false variable to true.

• For this go to wais-hunting/config.lua.
• Go to the Config.StartingItems table. This table type is an Array.
• Place one comma at the end of the last added item and create a new object.
• [“name”] = ‘ITEM_NAME’ This variable holds the name of the item to be assigned. Enter the item name where it says “ITEM_NAME”.
• If [“amount”] = 1, this is the quantity to be given for this item.
• The selected lines in the example below show the correct syntax and appearance that should be visible when newly added.
• textCopy

  Config.StartingItems = {
      {
          -- Hunting weapon given to players when they start the job.
          ["name"] = "weapon_musket",
          ["amount"] = 1,
      },
      {
          -- Ammunition for the hunting weapon given to players when they start the job.
          -- detect_auto: If you are using the Ox inventory, it will automatically provide musket ammunition. If you are using another inventory, it will automatically provide shotgun ammunition.
          -- If your musket ammunition is neither of these, please enter your musket ammunition.
          ["name"] = "detect_auto",
          ["amount"] = 100,
      },
      
      {
          ["name"] = "ITEM_NAME",
          ["amount"] = 1
      },
  }
  

• For this go to wais-hunting/config.lua.
• Find the Config.Vehicle table and go to that section.
• [“model”] = “mesa3”, This is the default vehicle model. Enter the name of the vehicle model you want to change in the section that says mesa3. Vehicle models

• For this go to wais-hunting/config.lua.
• Find the Config.Vehicle table and go to that section.
• [“maxDistance”] = 100.0, The default vehicle control distance is 100.0. This control exists to prevent vehicles from multiplying on the server and being abused.
• 100.0 is the control distance. My recommendation is to enter a distance that is 1.25 or 1.5 times greater than the size of the area. 424.0 is the distance at which an entity will not be rendered by the client.

• For this go to wais-hunting/config.lua.
• Find the Config.Vehicle table and go to that section.
• Find the [“outcoords”] table and add a comma to the rightmost vec4. There should not be more than one comma.
• Go to the next line and enter the vec4 position of the vehicle's new location.
• It should appear as shown in the selected line below.

    ["outcoords"] = {
        --[[
            Coordinates where the vehicle will spawn when taken out for the job.
        ]]
        vec4(-677.6839, 5826.7158, 17.1025, 135.5928),
        vec4(-680.4544, 5828.8892, 17.1015, 133.6158),
        vec4(-683.1483, 5831.2280, 17.1018, 134.0365),
        vec4(-685.2559, 5834.2231, 17.1021, 133.3776),
        
        vec4(0.0, 0.0, 0.0, 0.0),
    },

Step 1: Locate the Configuration File#

Open the config.lua file and find the Config.Zones section (around line 115).

Step 2: Understanding Zone Structure#

Each hunting zone contains the following properties:

Step 3: Copy the Zone Template#

Copy the template below and paste it at the end of the Config.Zones table (before the closing }):

{
    ["coords"] = vector3(0.0, 0.0, 0.0), -- Replace with your zone's center coordinates
    ["radius"] = 80.0, -- Zone radius in meters
    ["maxAnimals"] = 25, -- Maximum animals in this zone
    ["removeAnimal"] = 0.5 * 60 * 1000, -- 30 seconds before dead animals are removed
    ["spawnInterval"] = 0.75 * 60 * 1000, -- 45 seconds between spawns
    ["blips"] = {
        ["show"] = true, -- Set to false to hide the blip
        ["label"] = "Hunting Zone", -- Blip name on the map
        ["color"] = 5, -- Blip color (see: https://docs.fivem.net/docs/game-references/blips)
        ["scale"] = 0.7, -- Blip size
        ["sprite"] = 141, -- Blip icon (see: https://docs.fivem.net/docs/game-references/blips)
        ["radius"] = {
            ["show"] = true, -- Show radius circle on map
            ["color"] = 5, -- Circle color
            ["alpha"] = 80, -- Circle transparency (0-255)
        }
    },
    ["animals"] = {
        -- Add animals here (see Step 4)
        {
            ["model"] = "a_c_deer",
            ["rarity"] = 0.30,
        },
        {
            ["model"] = "a_c_boar",
            ["rarity"] = 0.40,
            ["canAttack"] = math.random(1, 10) >= 8 -- 20% chance to attack
        },
        {
            ["model"] = "a_c_rabbit_01",
            ["rarity"] = 0.30,
        },
    },
},

Step 4: Configure Your Zone#

Finding Coordinates

1. Go to your desired location in-game
2. Use a command or script to get your current coordinates
3. Replace vector3(0.0, 0.0, 0.0) with your coordinates

Example: vector3(-1234.56, 4567.89, 50.12)

Adjusting the Radius

The radius value determines the size of your hunting zone:

• Small zone: 40.0 - 60.0 meters
• Medium zone: 60.0 - 100.0 meters
• Large zone: 100.0+ meters

Setting Animal Limits

Adjust maxAnimals based on your zone size:

• Small zone: 10-15 animals
• Medium zone: 20-25 animals
• Large zone: 30+ animals

Configuring Spawn Timing

["removeAnimal"] = 0.5 * 60 * 1000,  -- 30 seconds
["spawnInterval"] = 0.75 * 60 * 1000, -- 45 seconds

To change these values:

• 0.5 = 0.5 minutes (30 seconds)
• 1.0 = 1 minute (60 seconds)
• 2.5 = 2.5 minutes (150 seconds)

Step 5: Adding Animals to Your Zone#

Available Animals

Understanding Rarity

⚠️ Important: The total rarity of all animals in a zone must equal 1.0 (100%)

Example:

["animals"] = {
    {
        ["model"] = "a_c_deer",
        ["rarity"] = 0.20, -- 20% chance
    },
    {
        ["model"] = "a_c_boar",
        ["rarity"] = 0.50, -- 50% chance
        ["canAttack"] = math.random(1, 10) >= 8 -- 20% attack chance
    },
    {
        ["model"] = "a_c_rabbit_01",
        ["rarity"] = 0.30, -- 30% chance
    },
    -- Total: 0.20 + 0.50 + 0.30 = 1.0 ✓
},

Attack Behavior

For aggressive animals, you can set attack probability:

["canAttack"] = math.random(1, 10) >= 7 -- 30% chance to attack
["canAttack"] = math.random(1, 10) >= 8 -- 20% chance to attack
["canAttack"] = math.random(1, 10) >= 9 -- 10% chance to attack
["canAttack"] = true -- Always attacks
["canAttack"] = false -- Never attacks

Step 6: Complete Example#

Here's a complete example of a new hunting zone:

{
    ["coords"] = vector3(-1234.56, 4567.89, 50.12),
    ["radius"] = 100.0,
    ["maxAnimals"] = 30,
    ["removeAnimal"] = 1.0 * 60 * 1000, -- 1 minute
    ["spawnInterval"] = 1.0 * 60 * 1000, -- 1 minute
    ["blips"] = {
        ["show"] = true,
        ["label"] = "New Hunting Zone",
        ["color"] = 2, -- Green color
        ["scale"] = 0.8,
        ["sprite"] = 141,
        ["radius"] = {
            ["show"] = true,
            ["color"] = 2,
            ["alpha"] = 100,
        }
    },
    ["animals"] = {
        {
            ["model"] = "a_c_deer",
            ["rarity"] = 0.25,
        },
        {
            ["model"] = "a_c_boar",
            ["rarity"] = 0.35,
            ["canAttack"] = math.random(1, 10) >= 8
        },
        {
            ["model"] = "a_c_rabbit_01",
            ["rarity"] = 0.20,
        },
        {
            ["model"] = "a_c_mtlion",
            ["rarity"] = 0.20,
            ["canAttack"] = math.random(1, 10) >= 7
        },
    },
},

Step 7: Save and Restart#

1. Save the config.lua file
2. Restart your resource: restart wais-hunting
3. The new zone will now be active!

• Maximum number of animals that can be present in the zone
• The number you will enter here is the maximum number of animals allowed for this area.
• When the maximum number of animals is reached, no new animals will spawn. Animals must be killed to change the animal population inside. Thus, as the number of animals decreases, new animals will spawn.

The deletion period for animals that have died but for which no action has been taken. If an animal dies and is not skinned, it will be deleted within this period.

• 0.5 * 60 * 1000 equals 30 seconds. It works as follows: Minute * 60 * 1000
• If no action is taken for an animal that is killed or dies naturally within the specified period, it will be automatically deleted.
• The reason for this is to prevent dead animals that have not undergone any processing from creating pollution and causing an unsightly appearance.

It is a set time cycle for spawning new animals in the area.

• If the specified number of animals is not present in the area after each specified period, a new animal spawns.

Step 1: Locate the Configuration File#

Open the config.lua file and find the Config.Missions section (around line 327).

Step 2: Understanding Mission Structure#

Each hunting mission contains the following properties:

Step 3: Copy the Mission Template#

Copy the template below and paste it at the end of the Config.Missions table (before the closing }):

{
    ["label"] = "Your Mission Name", -- Name displayed in the mission menu
    ["image"] = "https://example.com/your-image.jpg", -- Mission image URL
    ["description"] = "Your mission description here.", -- What the mission is about
    ["rewards"] = {
        ["money"] = 500, -- Money reward
        ["xp"] = 300, -- Experience points reward
    },
    ["animal"] = "a_c_deer", -- Animal model name to hunt
    ["requiredLevel"] = 1, -- Minimum level required (1-10)
    ["animalsToKill"] = 5, -- Number of animals to kill
},

Step 4: Configure Your Mission#

Setting the Mission Name

The label is what players will see in the mission menu:

["label"] = "Deer Hunting", -- Short and descriptive

Best Practices:

• Keep it short and clear (2-4 words)
• Include the animal name
• Add difficulty indicator if needed (I, II, Expert, Master, etc.)

Examples:

• "Deer Hunting"
• "Boar Hunt II"
• "Expert Predator Hunt"
• "Legendary Mountain Lion"

Adding a Mission Image

The image field requires a direct URL to an image:

["image"] = "https://example.com/deer-hunting.jpg",

Recommended Image Sources:

• Direct image URLs (must end in .jpg, .png, .webp)
• Imgur links
• GitHub user-content URLs
• Your own CDN/hosting

Image Requirements:

• Must be a direct link to the image file
• Recommended size: 800x600 or similar aspect ratio
• Formats: JPG, PNG, WEBP

Example URLs:

-- GitHub user content
["image"] = "https://user-images.githubusercontent.com/12345678/image.png",

-- Imgur
["image"] = "https://i.imgur.com/abc123.jpg",

-- Direct URL
["image"] = "https://yourserver.com/images/mission.png",

Writing a Description

The description should briefly explain what the mission involves:

["description"] = "Hunt deer in the forest area.",

Good Descriptions:

• "Hunt deer in the forest area." ✅
• "Track and hunt dangerous mountain lions. Be careful!" ✅
• "An expert-level deer hunting mission." ✅
• "Hunt multiple predators. Extreme caution required." ✅

Avoid:

• Too long descriptions (keep under 100 characters)
• Technical jargon
• Spoiling rewards in the description

Setting Rewards

Rewards consist of money and experience points:

["rewards"] = {
    ["money"] = 500,  -- Money in your server's currency
    ["xp"] = 300,     -- Experience points
},

Reward Balancing Guide:

Reward Formula:

Money per Animal = Total Money / Animals to Kill
XP per Animal = Total XP / Animals to Kill

Example: 
- Total: $1500, 500 XP, 10 animals
- Per Animal: $150, 50 XP

Important: If Config.SplitMissionRewards = true, these rewards will be divided among group members!

Choosing the Animal

The animal field specifies which animal model to hunt:

["animal"] = "a_c_deer",

Available Animals:

Selection Tips:

• Easy missions: a_c_deer, a_c_rabbit_01, a_c_pig
• Medium missions: a_c_boar
• Hard missions: a_c_mtlion

Setting Required Level

The requiredLevel determines when players can access the mission:

["requiredLevel"] = 1, -- Levels 1-10 available

Level Progression Guide:

Best Practices:

• Level 1: Always have 2-3 missions available
• Progressive difficulty: Each level should have 1-2 new missions
• Mix animals: Don't make all missions for one animal type

Setting Animals to Kill

The animalsToKill field determines how many animals must be hunted:

["animalsToKill"] = 5, -- Number of animals to hunt

Balancing Guidelines:

Considerations:

• Passive animals (deer, rabbit, pig): Can have higher kill counts
• Aggressive animals (boar, mountain lion): Lower kill counts
• Spawn rate: Check your zone's spawnInterval - longer intervals need fewer kills
• Group play: Higher kill counts work well for groups

• For this go to wais-hunting/config.lua.
• To do this, go to the Config.Rewards table.
• If you want to change the items given by an animal, look up the animal's model name in this table. Example: a_c_boar Result: joaat(“a_c_boar”).
• The table for the animal you found contains an items table. This items table is of type array. Here, you can create a new item or edit the item name.
• name = “ITEM_NAME”, amount = 1 - The item name should be entered where it says ITEM_NAME. The amount is the quantity of the item that will be given when this animal's skin is removed.

    [joaat("a_c_boar")] = {
        ["xp"] = 3,
        ["items"] = {
            { name = "ITEM_NAME", amount = 1 },
        }
    },

• For this go to wais-hunting/config.lua.
• To do this, go to the Config.Rewards table.
• This table shows the selling price of items provided for skinned animals.
• [“ITEM_NAME”] = 10, works as follows. ITEM_NAME => is the name of the item to be sold. 10 is the selling price of the item.

Config.AnimalPartsPrices = {
    --[[
        ⚠️⚠️⚠️
        Selling prices for each item obtained from hunting.
        The key represents the item name, and the value represents the selling price.
        ⚠️⚠️⚠️
    ]]

    ["boar_meat"] = 25,
    ["boar_skin"] = 40,
    ["boar_tusk"] = 15,
    ["pig_meat"] = 20,
    ["pig_skin"] = 35,
    ["pig_feet"] = 10,
    ["rabbit_meat"] = 10,
    ["rabbit_skin"] = 20,
    ["rabbit_feet"] = 5,
    ["mtlion_meat"] = 100,
    ["mtlion_skin"] = 150,
    ["deer_meat"] = 30,
    ["deer_skin"] = 50,
    ["deer_horns"] = 20,
    
    ["ITEM_NAME"] = 10,
}

• For this go to wais-hunting/config.lua.
• Go to the Config.StepperWidget table
• Find the variable [“show”] = true. Change the true value to false.

• For this go to wais-hunting/config.lua.
• Go to the Config.StepperWidget table
• [“label”] = “B”, indicates the button that will only appear in this box. It is the name that identifies the button on the interface.
• [“key”] = “B”, This variable is the name of the key that will be detected by the script in Fivem. You can find these keys here

• For this go to wais-hunting/config.lua.
• To do this, go to the Config.AnimalBlipstable.
• Find the variable [“enable”] = true. Change the value from true to false. This will disable the animals from appearing as blips on the map.

• For this go to wais-hunting/config.lua.
• To do this, go to the Config.GroupPlayerLimit variable.
• Config.GroupPlayerLimit = 4 The number 4 indicates the maximum number of users a group can have.
• 4 You can lower or raise the writing section. This allows you to adjust the maximum number of people.

• For this go to wais-hunting/config.lua.
• To do this, go to the Config.SplitMissionsRewards variable.
• If you set it to true, the total reward from the task is divided by the number of people in the group, and the reward per person is delivered. If you set it to false, the reward is given directly to everyone in the group in the specified amount.

• For this go to wais-hunting/config.lua.
• To do this, go to the Config.GroupMemberBlips variable.
• If you set it to true, group members' blips will be visible on the map. If you set it to false, group members' blips will not be shown.