Documentation

Installation

1. Drop the folder into your resources, keeping the name pledii_pets.

2. Import the database tables. Run installation/install.sql against your server's database. It creates two tables and is safe to run twice.

3. Add the three items. They are not in install.sql, because VORP and RSG define items in completely different places:

   • VORP — also run installation/items_vorp.sql.
   • RSG — open installation/items_rsg.lua and paste its three entries into rsg-core/shared/items.lua, under RSGShared.Items. Restart rsg-core.

   Item images are not included. Point the image field at art you already have, or drop in your own pet_food.png, pet_sponge.png, pet_tonic.png.

4. Start it after your framework and oxmysql:

   ensure pledii_pets
   

5. Give yourself the manager permission, in server.cfg:

   add_ace group.admin pledii_pets.manager allow
   

   Or for one person: add_ace identifier.license:xxxxx pledii_pets.manager allow

6. Check the console on first start. The resource prints one line telling you which framework it found and what it is selling:

   [pledii_pets] Pledii Pets v2.1.0 | framework: vorp | selling: pets for cash | config OK
   

   If anything in your config is wrong it prints a numbered list instead. Fix those before you go further — they are all things that would otherwise fail silently in front of a player.

7. Open config.lua and set the shop coordinates for your map. The two that ship are Saint Denis and Blackwater. Stand where you want a vendor and run /petshopcoords to print the numbers to paste in.

Requirements & Notes

Required

The artifact and OneSync requirements are declared in the manifest, so the resource refuses to start rather than half-work on a build that is too old.

Optional

• ox_lib — used for notifications if it is running. Without it the framework's own notify is used. Neither is required.
• A keybind resource — Config.PetInteraction.rebind lets players rebind the pet key through a keybind script you already run. Off unless configured.
• ricx_farmanimals — if you run it, dogs register as herding dogs and graze nearby farm animals automatically. Configurable in Config.PetShepherd, and skipped entirely when the resource is not present.
• An admin/logging resource — Config.Audit can hand purchase, rename, summon and death events to any resource you name, through export names you configure. Off by default.

Important

Two features ship switched off. They change the feel of the script a lot, so they are opt-in rather than something you discover after install:

• Config.PetMetabolism.enabled = false — the survival loop. Turn it on and animals get hungry and dirty, catch diseases and can die of neglect. Turn it on before players get attached to anything.
• Config.PetFetch.enabled = false — foraging. The loot tables reference item names from a specific server; check every entry against your own items table before enabling it, or pets will come back with items you do not have.

The loot and supply item names are a starting point, not a guarantee. Item ids differ between servers. pet_food, pet_sponge and pet_tonic are created by the install files, but everything in the fetch tables assumes item names your database may not use.

Translations are uneven. English is complete at 244 strings. Georgian is complete. The other seven — Arabic, German, Spanish, Italian, Portuguese, Russian, Turkish — define 112 strings each and fall back to English for the rest, so roughly half of those menus will read in English until you fill them in. The files are unencrypted and adding a key is one line.

One shop breed needs an external download to look right. The MP Foxhound row is the multiplayer foxhound model the base game already has. A free community retexture turns it into a German Shepherd — see docs/GERMAN_SHEPHERD.md for the link and the caveats. Nothing is bundled and nothing breaks without it.

No game files are streamed. This resource ships no models, no textures and no audio taken from RDR2. Everything in web/ was generated by the scripts in tools/, and the three typefaces are SIL Open Font License 1.1 with their licence texts in licenses/. If you redistribute the resource, those licence files must travel with it.

What stays editable under escrow

Escrow only encrypts Lua. These files ship readable so the script stays yours to adapt:

• config.lua — the whole config
• game/shared/Locale.lua and locales/*.lua — every string
• game/bridge/client/Client.lua and game/bridge/server/Server.lua — the framework adapter
• game/server/Validate.lua — the startup check
• installation/* — the SQL and the RSG item snippet

Everything under web/, tools/, docs/ and licenses/ is not Lua and is readable regardless.

Commands

All of them can be renamed or disabled in Config.Commands — set one to '' and it is not registered at all.