# Waypoint Animals

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.

{% embed url="<https://www.youtube.com/watch?v=ltFPUDdQpTI>" %}

[Purchase Here](https://backsh00ter.tebex.io/package/6291394)

[CFX Post](https://forum.cfx.re/t/paid-qb-esx-ox-waypoint-animals/5238437)

### 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

### Performance

* Idle / Following / Actions / Fetch: 0.00ms&#x20;
* Store UI / Hold / : 0.01ms&#x20;
* Raycast Actions (Go to point, get in vehicle, etc): 0.03ms - 0.07ms&#x20;
* Prop Customization: 0.01ms - 0.10ms (only while quickly cycling through and moving props)

### Dependencies

* **Framework**: QBCore, Qbox, 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)
* Zone: [PolyZone](https://github.com/mkafrin/PolyZone) or OX (used just for detecting when you are in the store) or use Target, in which case zone is not necessary.
* SQL database
* [menuV](https://github.com/ThymonA/menuv)
  * We use `menuv` for the menu system for controlling, customizing and animating the animals.

{% hint style="info" %}
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.
{% endhint %}

### Credit

* [MissySnowie](https://www.gta5-mods.com/users/MissySnowie) for custom hold animations
* DonHulieo for providing insipiration and examples for structuring the framework.lua file.
* Project Error - [fivem-react-boilerplate-lua](https://github.com/project-error/fivem-react-boilerplate-lua)

### Gallery

<figure><img src="/files/V1mP3ueUgw8ovF9jpkzu" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/nF2vZxodl3VFokceNs7B" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/FOEl9QbgkZJE2fgNk0Pj" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/9WWBWUqAAs9WqfYixUbF" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/1NYow43nSVrZxLTUI1jh" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/8qEQFH0BpLzXLlqGF0gF" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/5IqQWcGuFfFn8lWqvlYE" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/j58r02ubnlFxBNamv8gk" alt="" width="300"><figcaption></figcaption></figure>

<figure><img src="/files/XKvbzPLJfxNxGXdEn1N1" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/LAi1hf1yBv8HYKwXtNQ6" alt="" width="375"><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://waypoint-scripts.gitbook.io/waypoint-scripts/scripts/waypoint-animals.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.