GFX Chicken Job

A chicken farming simulation script for FiveM. Players can purchase farms, place eggs, hatch them into chickens, feed and manage chickens, collect eggs produced by chickens, and sell eggs and chickens for profit.

Info

Dependencies

Installation

1. Copy the resource folder

Place the gfx-chickenjob folder into your server's resources directory.

2. Add to server.cfg

ensure gfx-chickenjob

3. Configure items

Make sure the following items exist in your framework's item list:

• egg (or whatever you set Config.EggItem to) -- used for placing/collecting eggs
• chicken-feed (or whatever you set Config.ChickenFeedItem to) -- used for feeding chickens

4. Configure the script

Edit config.lua to match your server's framework, notification system, farm locations, and pricing.

Configuration

Farm Definition Structure

Each entry in Config.Farms follows this structure:

{
    DefaultName = "Grapeseed Chicken Farm",          -- Display name before purchase
    Photo = "https://example.com/farm-photo.jpg",    -- Photo URL shown in purchase UI
    Price = 200000,                                  -- Purchase price
    Coords = vector3(2306.42, 4885.97, 41.81),      -- Main interaction coordinates
    Camera = vector4(2182.96, 4910.91, 100.33, 262.45), -- Camera position for purchase preview
    ChickenPoints = {                                -- Chicken/egg spawn positions (max 15)
        vector4(2258.07, 4899.96, 40.81, 225.26),
        vector4(2259.86, 4901.6, 40.81, 203.59)
    }
}

Custom Notification Example

ClientNotify = function(title, msg, type)
    -- Replace with your notification system
    exports['mythic_notify']:DoHudText(type, msg)
end,

ServerNotify = function(player, title, msg, type)
    TriggerClientEvent('mythic_notify:client:SendAlert', player, {type = type, text = msg})
end

Exports

No exports are created by this script.

Events

No public API events are exposed by this script. All events are internal (prefixed with the resource name) and used for client-server communication within the script.

Commands

No commands are registered by this script. All interactions are done via the NUI menu and 3D markers/prompts in the game world.

Features

• Farm Purchasing -- Players can buy chicken farms at configurable locations. A camera preview shows the farm before purchase.
• Farm Selling -- Farm owners can sell their farm back at a configurable tax rate (default 25% deduction).
• Farm Name Customization -- Farm names can include the owner's first/last name via FarmNameFormat placeholders.
• Egg Management -- Players place eggs from their inventory into the farm. Eggs have an incubation timer before they can be hatched into chickens.
• Egg Hatching -- Once incubation completes, eggs can be broken to hatch a new chicken (with a particle effect).
• Egg Removal -- Eggs can be removed from the farm. There is a 50% chance of recovering the egg item; otherwise it breaks.
• Chicken Management -- Chickens have hunger and ovulation timers. They gain experience over time which reduces their ovulation period.
• Chicken Feeding -- Chickens must be fed using the configured feed item. Hunger decreases over time, and chickens die if hunger reaches 0.
• Egg Collection -- When a chicken's ovulation timer completes, the player can collect an egg item from it. This also grants experience to the chicken.
• Chicken Selling -- Chickens can be sold for the configured ChickenSellPrice.
• Egg Sell Mission -- A seller NPC at a configurable location lets players call a courier vehicle. Players load their egg items into the vehicle and sell them at the configured EggSellPrice per egg.
• Job Requirement -- The egg sell mission can optionally require a specific job (e.g., "farmer").
• Map Blips -- Blips are placed on the map for each farm and the egg seller NPC. Blips can optionally change appearance when a farm is purchased.
• NUI Interface -- A full HTML/CSS/JS user interface for farm management, egg/chicken interactions, purchase confirmations, and the sell mission.
• 3D Markers & Text -- Color-coded markers and floating text show chicken hunger, ovulation status, and egg incubation progress in the game world.
• Notifications -- Players receive notifications for key events: purchase, egg hatching ready, chicken hungry, chicken death, feeding, and more.
• Localization -- Full translation support via locale files (English included by default).
• Persistent Data -- Farm ownership, chickens, and eggs are saved to JSON files (data/chicken_farms.json, data/chicken_animals.json, data/chicken_eggs.json) and persist across restarts.
• Multi-Framework -- Supports both ESX and QBCore frameworks.

Troubleshooting