Waypoint Animals is a script that lets players bring their animal/pet companions into the world and expand their creative opportunities. Players can interact with their animals in a variety of ways, such as petting, holding them, playing fetch, playing animations, having them follow you around on foot or in a vehicle. Animals can be fully customized, choosing from the color of their fur/skin, collars, and accessorizing with a variety of props that can be placed however the user likes.
Preview Video
Purchase on Tebex
Features
-
Comes with 20 animals to choose from by default. Can easily be expanded by adding your own custom animal models.
-
No limit to the number of animals that can be controlled at the same time
-
Full customization of your pets (fur/skin color, collars, accessorize with prop customization)
-
Interact with animals in a variety of ways (petting, holding, playing fetch, playing animations, having them follow you around on foot or in a vehicle)
-
Control animals with the following actions: follow, stay, go to point, get in/out vehicle, wander in the area, attack (configurable via a config flag)
-
A simple store UI is provided to purchase animals from and retrieve lost animals from “the pound”
-
Animals can be placed and picked up by anyone.
-
Animals are stored as items in your inventory, simply use the item to place it into the world.
-
Interact with animals through the target system as well as through the /animals menu.
-
Synchronized across all clients
The attack action is behind a feature flag to enable. I recommend implementing server rules to guide players on its usage, as it can be easily exploited in ways that might adversely affect roleplay (RP)
Customize Animals
When purchasing an animal you can choose the name, color, collar (if applicable).
After purchasing you can customize the collar color through the menu. There is a full prop placement system that allows you to accessorize the animals with props. The animals can currently be customized with 5 different prop slots. Props can quickly and easily be adjusted / changed through the menu at any time.
Add additional props (including custom props) to the Config.PropOptions table.
Performance
-
Idle / Following / Actions / Fetch: 0.00ms
-
Store UI / Hold / : 0.01ms
-
Raycast Actions (Go to point, get in vehicle, etc): 0.03ms - 0.07ms
-
Prop Customization: 0.01ms - 0.10ms (only while quickly cycling through and moving props)
Dependencies
-
Framework : QBCore, ESX
-
Notify : QB, ESX, OX, or similar
-
Target : QB, OX, or similar
-
Progressbar : QB, OX, or similar
-
Inventory : QB, OX, or similar (must have support for item metadata)
-
SQL database
-
- We use
menuvfor the menu system for controlling, customizing and animating the animals.
- We use
-
PolyZone (used just for detecting when you are in the store)
All framework / external script dependencies are configurable within the framework.lua file and can be easily changed to fit your server’s needs. Additionally all files for the store (web and client) and menu code are open source.
Documentation and Setup Instructions provided here
| Code is accessible | Config, Framework, Store (ui and lua), Menu |
| Subscription-based | No |
| Lines (approximately) | ~2000 |
| Requirements | qbcore or esx, target, inventory, menuV, PolyZone |
| Support | Yes |
Gallery
Credit
-
MissySnowie for custom hold animations
-
DonHulieo for providing insipiration and examples for structuring the framework.lua file.
-
Project Error - fivem-react-boilerplate-lua
I recommend implementing server rules to guide players on its usage, as it can be easily exploited in ways that might adversely affect roleplay (RP)
Waypoint Animals - v1.0.3
