Diamond Butcher Job

Overview

Diamond Butcher Job provides two multi-stage production lines. Players process beef through a conveyor, grinder, and packing stations; poultry is plucked, gutted, chopped, and packaged. Finished goods can be sold to a configurable NPC.

Compatibility matrix

Requirements

Required resources

• es_extended — framework required by the current manifest.
• ox_inventory — item lookup, item removal during selling, item images in menus, and standalone item operations.
• ox_target — station and NPC interactions.
• ox_lib — callbacks, progress UI, context menus, alerts, and dialogs.
• oxmysql — loaded by fxmanifest.lua, even though v1.0.0 contains no SQL queries.

Optional resources

• Notifier, core_notify, or mythic_notify when selected in Config.NotificationSystem.
• An external hunting or farming script that gives players raw_meat and raw_chicken.
• An ESX job creator or database access to create the butcher job.

Installation

1. Keep the resource folder name.

   Place the resource at resources/[jobs]/diamond_butcherjob. The external event examples on this page assume that exact folder and resource name.

2. Install and start all dependencies.

   Use the startup order below. The resource must start after ox_lib, ox_target, ox_inventory, oxmysql, and ESX.

3. Register all nine items.

   Copy the provided item definitions into ox_inventory/data/items.lua. Make sure commas before and after the pasted block are correct.

4. Copy the item images.

   Copy every PNG from diamond_butcherjob/install/images into ox_inventory/web/images.

5. Create the butcher job.

   The resource does not create jobs automatically. Add an ESX job named exactly butcher, or change Config.RequiredJobName to an existing job.

6. Choose a notification system.

   Set Config.NotificationSystem to an installed provider. ox_lib is the simplest supported choice.

7. Provide raw materials.

   Connect a hunting, farming, shop, or admin system that supplies raw_meat and raw_chicken.

8. Restart and run the acceptance test.

   Test the complete beef and chicken chains, each sell mode, the job restriction, cancellation, full inventory behavior, and /propfix.

Recommended server.cfg order

# Database/library resources loaded by the manifest
ensure oxmysql
ensure ox_lib

# Framework supported by the shipped v1.0.0 manifest
ensure es_extended

# Required inventory and targeting resources
ensure ox_inventory
ensure ox_target

# Optional notification resource only when selected in config.lua
# ensure Notifier
# ensure core_notify
# ensure mythic_notify

# Start the job after every dependency
ensure diamond_butcherjob

Job Setup

By default, Config.RequireJob = true and Config.RequiredJobName = 'butcher'. The script checks only the job name; it does not require a grade, boss status, or on-duty state.

Common ESX Legacy SQL example

-- Example for the common ESX Legacy jobs/job_grades schema.
-- Back up the database and adapt columns if your schema differs.
INSERT IGNORE INTO `jobs` (`name`, `label`)
VALUES ('butcher', 'Butcher');

INSERT IGNORE INTO `job_grades`
(`job_name`, `grade`, `name`, `label`, `salary`, `skin_male`, `skin_female`)
VALUES
('butcher', 0, 'trainee', 'Trainee', 0, '{}', '{}'),
('butcher', 1, 'worker', 'Butcher', 0, '{}', '{}'),
('butcher', 2, 'senior', 'Senior Butcher', 0, '{}', '{}'),
('butcher', 3, 'boss', 'Manager', 0, '{}', '{}');

Disable the job restriction

Config.RequireJob = false
-- All players can now use processing stations and sell goods.

Inventory Items and Images

The package contains definitions and matching PNG images for all nine required items. The note at the bottom of the bundled ox_inventory.txt says images were not supplied, but that note is outdated.

Provided ox_inventory definitions

["raw_meat"] = {
	label = "Raw Meat",
	weight = 200,
},
["raw_chicken"] = {
	label = "Raw Chicken",
	weight = 100,
},
["processed_meat"] = {
	label = "Processed Meat",
	weight = 200,
	stack = true,
	close = true,
	description = 'Freshly butchered and processed meat.'
},
["ground_beef"] = {
	label = "Ground Beef",
	weight = 200,
	stack = true,
	close = true,
	description = 'Fresh from the meat grinder and ready to pack.'
},
["packed_groundbeef"] = {
	label = "Ground Beef",
	weight = 200,
	stack = true,
	close = true,
	description = 'Freshly packed ground beef, ready to cook.'
},
["packaged_chicken"] = {
	label = "Chicken fillet",
	weight = 100,
	stack = true,
	close = true,
	description = 'Freshly packed chicken, ready to cook.'
},
['plucked_chicken'] = {
	label = 'Plucked Chicken',
	weight = 100,
	stack = true,
	close = true,
	description = 'Freshly plucked, ready to be gutted.'
},
['gutted_chicken'] = {
	label = 'Gutted Chicken',
	weight = 100,
	stack = true,
	close = true,
	description = 'Freshly gutted chicken, ready to be chopped.'
},
['chopped_chicken'] = {
	label = 'Chopped Chicken',
	weight = 100,
	stack = true,
	close = true,
	description = 'Freshly chopped chicken, ready to pack.'
}

Image installation

Source: diamond_butcherjob/install/images/*.png
Destination: ox_inventory/web/images/

Workflow and Locations

Beef workflow

Players obtain raw_meat, use the conveyor to create processed_meat, use the grinder to create ground_beef, and package it into packed_groundbeef.

Chicken workflow

Players obtain raw_chicken, then use the plucking, gutting, chopping, and packaging stations in order.

Configured stations

Server-enforced yields

Default sell prices

The NPC offers two modes: sell every configured sellable item in the player inventory, or choose one item and quantity.

Configuration Reference

Example economy adjustment

Config.ProcessingYields.raw_meat.processed_meat = { min = 1, max = 2 }
Config.SellPoint.prices.packed_groundbeef = 25
Config.SellPoint.prices.packaged_chicken = 20

Raw Material and Hunting Integration

Diamond Butcher Job does not spawn animals or generate raw inputs. Another resource must add raw_meat and raw_chicken to the player's inventory. The bundled README recommends ars_hunting, but any hunting, farming, shop, reward, or admin system can be used.

External hunting item example

-- Example item rewards inside an external hunting resource
meat = {
    {
        item = 'raw_meat',
        chance = 100,
        maxQuantity = 3,
    },
}

-- Use raw_chicken for poultry hunting/collection sources.
-- The item names must exactly match Diamond Butcher Job's config.lua.

Integration checklist

• The hunting item keys match Config.Conveyor.requiredItem and the chicken plucking station item.
• The items exist in ox_inventory.
• Matching PNG images exist in ox_inventory's image directory.
• The hunting resource starts before players attempt the butcher workflow.
• The server economy accounts for both hunting yield and butcher processing yield.

Events, Callback, and Exports

Supported external client event: open main menu

Opens the NPC's main context menu from another client resource.

-- Client-side: open the main butcher NPC menu
TriggerEvent('diamond_butcherjob:openButcherMenu')

Supported external client event: open selling menu

Opens the sell-all / sell-specific menu directly. Server-side selling still checks the configured job.

-- Client-side: open the selling menu directly
TriggerEvent('diamond_butcherjob:openSellDialog')

Available ox_lib callback: check job access

Returns the result of Config.HasJob(source). This is useful when another client resource needs to show or hide a butcher interaction.

-- Client-side, requires ox_lib
local isButcher = lib.callback.await('diamond_butcherjob:hasJob', false)

if isButcher then
    print('Player has access to the butcher job')
end

Export status

Commands

Troubleshooting

Support-ticket checklist

• Diamond Butcher Job version and folder name.
• Framework version and exact job name.
• ox_inventory, ox_target, ox_lib, and oxmysql versions.
• Selected notification provider.
• Full client F8 and server-console errors.
• Station, item, and exact reproduction steps.
• Any edits made to config.lua, locale.lua, or the manifest.

Updates and File Map

Editable files

Safe update procedure

1. Back up the entire resource and your edited config.lua and locale.lua.
2. Compare the new manifest, config structure, item keys, and event/API notes.
3. Do not overwrite custom coordinates or economy values blindly.
4. Restart in a test environment and run both complete processing chains.
5. Confirm external resources still use supported events or exports for the installed version.