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.
Install
Install the resource
Download Sky Pets from the Cfx.re Portal, extract the download, and upload the sky_pets folder containing fxmanifest.lua to your server's resources directory. Keep the folder name sky_pets.
For an update, back up your configuration and database, replace the resource files with the new download, and merge your settings into the new configuration files. Keep the existing pet database.
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
Open Inventory items, choose your inventory's tab, and merge the definitions into its existing item catalogue. For ox_inventory, use ox_inventory/data/items.lua. The download's installation attachments contain installation/ox_inventory.lua and installation/inventory-images/; copy the matching images to ox_inventory/web/images/.
For ESX's database-backed inventory, apply sky_pets/import.sql manually to insert the default item rows even if automatic pet-schema migration is enabled.
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 appears, 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.
If the shop or purchase fails, use Troubleshooting and inspect both server and F8 output.