#🐾 FX-PETS

Advanced pet system for RedM that allows players to own, manage, and interact with animals including feeding, following, reviving, and combat behavior.

---

#📦 Installation

bashensure fx-pets

• Place the script inside your resources folder
• Add ensure fx-pets to your server.cfg
• Restart your server

---

#🗄️ SQL Setup (VORP)

sqlINSERT INTO items (...)
VALUES ('petbox', 'Pet Box', ...)

• Required items for pet system
• Includes petbox, petfood, petrevive, petwater

---

#📦 Items (RSG)

luapetbox = { name = 'petbox', label = 'Pet Box' }

• Add items to rsg-core/shared/items.lua
• Items must be usable

---

#⚙️ Basic Configuration

luaConfig.Language = "en"
Config.MyPetsCommand = "mypets"

• Command to open pet menu → /mypets
• Language system supported

---

#🌐 Locale System

luaConfig.Locale = {
  ["en"] = {},
  ["tr"] = {}
}

• Multi-language support
• Fully customizable

---

#🐕 Pet Ownership Settings

luaConfig.PetOwnershipLimit = 5
Config.PetOutLimit = 2

• Limit how many pets a player can own and spawn
• Set false for unlimited

---

#🧠 Pet Stat System

luaConfig.PetStatSettings = {
  hunger = {},
  thirst = {}
}

• Hunger & thirst system
• Dynamic stat decrease

---

#❤️ Damage System

luaConfig.PetDamageSystem = {
  enabled = true
}

• Pets take damage when starving or dehydrated
• Fully configurable

---

#💊 Consumables

luaConfig.Consumables = {
  food = { petfood = 50 },
  drink = { petwater = 50 }
}

• Feeding system
• Restores hunger and thirst

---

#🩺 Heal & Revive System

luaConfig.ReviveItems = {
  ["petheal"] = {},
  ["petrevive"] = {}
}

• Heal and revive pets
• Supports animations and effects

---

#🎮 Pet Controls

luaConfig.RightClickShortCut = {}

• Sit / Follow / Heal / Revive / Go Home
• Fully customizable controls

---

#🐾 Pet Commands System

luaConfig.PetCommands = {
  ["dog"] = {}
}

• Per-pet command system
• Example: follow, stay, attack

---

#🎭 Animations

luaConfig.Animations = {
  ["dog"] = {}
}

• Custom animations per pet type
• Includes idle, eat, sit, etc.

---

#🐾 Pet Definitions

luaConfig.Pets = {
  ["A_C_DogHusky_01"] = {}
}

• Defines all pets
• Includes scale, behavior, abilities

---

luaConfig.Pets = {
  ["a_c_custom_pet"] = {
    babyScale = 0.6,
    maxScale = 1.0,
    petType = "dog",
    icon = "a_c_custom_pet",
    isPedCanAttack = true,
    canRevive = true
  }
}

• You can create custom pets by adding new entries
• Each pet must have a unique model name
• icon must match image file name

---

#🛒 Pet Shop System

luaConfig.PetMarket = {}

• Main pet shop configuration
• Controls categories and availability

---

luaConfig.PetMarket = {
  ["BLACKWATER"] = {
    ["Custom"] = {
      pets = {
        ["a_c_custom_pet"] = {
          title = "Custom Pet",
          cash = 100
        }
      }
    }
  }
}

• Add custom pets into market categories
• Controls how players buy pets
• Supports multiple locations and categories

---

#🖼️ Pet Image Setup

textui/assets/pets/a_c_custom_pet.png

• Add pet images inside ui/assets/pets
• Image name must match model name
• Used for UI display

---

#🗺️ Market Locations

luaConfig.Markets = {
  ["BLACKWATER"] = {}
}

• Defines NPC shop locations
• Includes spawn, camera, and interaction

---

#🎨 UI Settings

luaConfig.Theme = "Dark"

• Supports Light / Dark mode
• Fully customizable UI

---

#🔄 Growth System

luaConfig.OneYear = 172800

• Pets grow over time
• Scale increases dynamically

---

#🔔 Notification System

luaNotify({
  text = "Message"
})

• Supports VORP / RSG / REDEMRP
• Handles all notifications

---

#📤 Export

luaexports['fx-pets']:IsEntityPet(entity, cb)

• Checks if entity is a pet
• Returns result via callback

---

#🌐 Server Config

luaSV_Config.Webhook = {}

• Discord webhook system
• Logs important actions

---

#⚠️ Important Notes

• Items must be installed
• Pet model names must match config
• Images must exist for UI
• Pet limits must be configured
• Animations must exist per pet

---

#🚨 Common Issues

• Pet not spawning → item missing
• Pet not visible → image missing
• Pet not working → wrong model name
• Cannot buy pet → market config wrong
• Pet dying → hunger/thirst enabled

---

#🏁 Summary

FX-PETS provides:

• Advanced pet system
• Custom pet support
• Hunger & thirst system
• Combat & behavior system
• Market & shop system
• Full framework compatibility

---

© Fixitfy Development