sh-k9

This documentation covers all features of the K9 script for FiveM, available for QB, QBX, ESX, ND frameworks or as a standalone version.

Combat & Positioning

Attack - Target players or NPCs by aiming and pressing E
- Tackle - Dogs have a chance to tackle targets (see update 2.1 for details)
Send to Location - Direct your dog to any spot by aiming and pressing G
Follow Modes
- Normal Follow - Dog stays close to handler
- Lead Follow - Dog walks ahead of handler
Leash System - Added in Update 4.0

Vehicle Interaction

Enter/Exit Vehicle
- Teleport - Instant entry/exit
- Realistic Animation - Dog jumps in/out of vehicles

Police Work

Searching Capabilities
- Search vehicles, players, or NPCs
- Player search methods:
  - Aim on specific person and select search option in menu
  - Automatic detection of closest player
Tracking System
- Detect hidden players within configurable smell radius
- Balanced mechanics to prevent gameplay exploitation
- Adjustable tracking speed and cooldown periods
- Performance tied to dog's level/relationship system

Health Management

Health & Armor System
- Configurable maximum health and armor values
- Apply bandages to heal injured dogs
- Apply armor for protection
- Database storage for health/armor status (optional)
- Revive system for fallen K9s

Status Check - Monitor your dog's condition
Carry Dog - Pick up and transport your K9
Play Fetch - Interactive play with ball or frisbee
Feeding System - Place food bowl that dog will find automatically
Dog House
- Build/destroy dog houses
- Command dog to enter/exit house
Appearance Customization
- Random style selection
- Detailed customization menu
- Database storage of appearance settings
Animation System
- Variety of realistic preset animations
- Animations tied to relationship level
Camera System - Mount camera to dog's neck for K9 perspective
GPS Tracking - Always know your dog's location

Hunger & Thirst
- Regular feeding requirement
- Configurable options:
  - Health damage when hungry/thirsty
  - Customizable depletion rates
Natural Functions
- Bathroom needs triggered after multiple feedings
- Can be disabled in configuration

Leveling Mechanics (disabled by default)
- XP gained through various actions
- Database storage of progress
- Affects command success rates
- Influences tracking and searching effectiveness
- Fully customizable levels, XP rewards, and failure percentages

Insta-headshot toggle
ACE Permissions and Discord Roles for non-framework users
Job Restrictions with grade-level requirements
Target System Support
- Compatible with qb-target, ox_target, qtarget
Multiple Dog Models
- Default shepherd and rottweiler models
- Support for premium models:
  - German Shepherd/Malinois
  - Mouby's Dog House models
  - Additional Mouby's models
  - Unlimited custom model support
Dog Limit - Configurable maximum dogs per player/character

Chat Commands for all actions
- Customizable command names
Translation Settings for multi-language support
Custom UI
- Control menu for dog management
- Status window displaying vital statistics (thirst, hunger, armor, health)
FiveM Keybinds for quick actions

Multiple Save Options
- Database saving via oxmysql
- JSON alternative for servers without database support
Support for Marx's Prop Pack
- Automatic camera prop display on dog's neck
- Customizable basic props

Fully supports QBCore, QBX, ESX Legacy, ND Core frameworks
Standalone version for custom framework integration
Completely open bridge files to adapt the script to any server
Supported inventories: qb, ox, lj, ps, qs, esx
Can be used without any framework/database/inventory (certain features will be disabled)