Adding/Removing Species

Adding a New Pet Species

---

1) Add the Species to config.lua

Open:

• hoff-battlebuddies/config.lua

Scroll down to Config.Species and add your new entry at the bottom. Double-check your commas/brackets so you don’t introduce a syntax error.

Example:

hen = {
	DisplayName = "Hen",
	Model = "A_C_Hen",
	Type = "Flying",
	Item = "battlepet_caged_hen",
	AbilitySet = {
		{ Level = 1,  Id = "peck" },
		{ Level = 2,  Id = "squawk" },
		{ Level = 4,  Id = "egg_barrage" },
		{ Level = 10, Id = "slicing_wind" },
		{ Level = 15, Id = "adrenaline_rush" },
		{ Level = 20, Id = "flock" },
	},
	DefaultActives = { "peck", "squawk", "egg_barrage" },
	BaseStates = { [18] = 0, [19] = 0, [20] = 0 },
	Icon = "pets/hen.png",
},

BaseStates keys:

• 18 = Power

• 19 = Stamina

• 20 = Speed

---

2) Add the Pet Icons (UI)

Go to:

• hoff-battlebuddies/ui/assets/images/pets/

Add two PNG files (both should be 256×256):

• Thumbnail: <species>_thumb.png Example: hen_thumb.png

• Head icon: <species>.png Example: hen.png

---

3) Link Animations for the Model

Open:

• hoff-battlebuddies/shared/open/sh_anims.lua

Find the AnimMap table and add a new entry for your model near the bottom.

Example (Cow):

A_C_Cow = {
	Death       = { Dict = "creatures@cow@move", Clip = "dead_left" },
	BasicMelee  = { Dict = "creatures@cow@move", Clip = "gallop" },
	BasicRanged = { Dict = "creatures@cow@player_action@", Clip = "action_a" },
	Roar        = { Dict = "creatures@cow@player_action@", Clip = "action_a" },
	GetPet      = { Dict = "creatures@cow@amb@world_cow_grazing@idle_a", Clip = "idle_a", BlendSpeed = 4.0 },
	Emote       = { Dict = "creatures@cow@amb@world_cow_grazing@idle_a", Clip = "idle_a", BlendSpeed = 4.0 },
	Sit         = { Dict = "creatures@rottweiler@incar@", Clip = "sit" },
	Carry       = {
		Dict = "creatures@rottweiler@incar@",
		Clip = "sit",
		Offset = vector3(0.0, -0.1, 0.0),
		PlayerDict = "anim@heists@box_carry@",
		PlayerClip = "idle",
	},
},

Notes on Animations

Most animals reuse an existing animation set from another animal. Example: A_C_MtLion and A_C_Panther both use cougar animations.

Common optional animation entries:

• Emote = random idle/emote used by wild pets

• Sit = used when the pet is seated in a vehicle

• Carry = used when the player is carrying the pet

Animation Keys

These keys can be used inside any animation entry (like Death, GetPet, Carry, etc):

• Dict — animation dictionary name

• Clip — animation clip name inside the dictionary

• BlendSpeed — how fast the animation blends in (default: 8)

• Duration — how long the animation runs in ms (default: 1000)

• PlaybackRate — playback speed multiplier (default: 0)

---

Carrying Anim Settings

If you leave out PlayerDict / PlayerClip, the pet still attaches, but the player won’t be forced into an animation. This is great for small pets like rats sitting on a shoulder.

Example:

Carry = {
	Dict = "creatures@rat@move",
	Clip = "idle",
	Offset = vector3(-0.175, -0.15, -0.025),
	Rotation = vector3(0.0, -30.0, 0.0),
	PlayerBone = 10706,
},

---

4) Add the Caged Pet Item

Your species needs a matching caged pet item so players can receive it and add it to their journal.

QB-Core Pet Item

Add this to:

• resources/[qb]/qb-core/shared/items.lua

Example:

battlepet_caged_pig = {
	name = "battlepet_caged_pig",
	label = "Pet Cage (Pig)",
	weight = 500,
	type = "item",
	image = "battlepet_caged_pig.png",
	unique = true,
	useable = true,
	shouldClose = true,
	description = "Use: Add this pet to your collection."
},

ox_inventory Pet Item

Add this to:

• ox_inventory/data/items.lua

Example:

['battlepet_caged_cow'] = {
	label = 'Pet Cage (Cow)',
	weight = 500,
	stack = false,
	close = true,
	description = 'Use: Add this pet to your collection.',
	server = { export = 'hoff-battlebuddies.ox_cagepetitem' }
},

---

Testing Your New Species

Restart the server so the images and item changes are picked up.

Then test with:

/petadmin give <speciesId> <level>

Example:

/petadmin give hen 1

---

Removing a Species

To remove a species:

1. Open config.lua

2. Delete or comment out the entry in Config.Species

Recommended cleanup (optional):

• Remove it from any wild zones (if used)

• Remove it from any trainer teams (if used)