Browse docs
Installation
Requirements
| Requirement | Purpose |
|---|---|
sky_base | Framework, database, inventory and shared interaction bridge |
| OneSync | Networked pet entities and server-side validation |
| Configured SQL provider | Persistent ownership, settings, health, training and duel data |
| Configured inventory provider | Food, water, treats, toys and medical items |
sky_jobs_base, Police, Fire and Ambulance are optional service-dog integrations. No Node.js or Vue build is needed for the prepared customer resource.
Install
Copy the release
Put the supplied inner resource directory in your server's resources folder and name it exactly sky_pets. Do not install the repository's frontend, storage, tools, or tests directories on the server. When replacing an old release, use a clean resource directory so retired streamed assets are not left behind. Back up configuration and database data first.
The Vinewood Petshop MLO is already bundled under sky_pets/stream/Petshop/ and loaded by fxmanifest.lua. Keep the streamed files in the resource; the interior does not need a separate ensure entry.
Register inventory items
Merge the supplied docs/customer/ox_inventory.lua entries into your existing ox_inventory/data/items.lua return table, and copy the corresponding images from docs/inventory-images to ox_inventory/web/images. For another inventory, register the same item IDs through the inventory provider configured in sky_base. See Inventory items.
Start dependencies first
# Start your framework, database and inventory resources before sky_base.
ensure sky_base
ensure sky_pets
Start installed Sky Jobs or medical resources before sky_pets when you use their service-dog integration. Optional breed add-ons are separate and are not needed for this core installation.
Check the database and first start
Config.AutoExecuteQuery = true creates or updates the pet schema at startup. The configured sky_base database user needs schema and data privileges. If you disable automatic pet-data migration, apply the current sky_pets/import.sql before starting. Do not drop existing pet tables during an update.
First verification
Join as a regular player. Confirm the Vinewood shop opens, a preview dog renders, purchase uses the configured account, the new pet appears in the F6 menu, and it remains owned after reconnect. Then test one consumable item and one reusable toy. Browser or offline checks cannot establish that the streamed models, animations or camera placement render correctly in FiveM.
If the shop or purchase fails, use Troubleshooting and inspect both server and F8 output.