# Gw Animals Install Guide

Welcome to the documentation for **GW-Animals**, the most immersive and high-performance animal tracking system for RedM. This script introduces a sleek 3D UI that renders directly in the game world, providing real-time data on wildlife without breaking immersion.

## ✨ Premium Features

* **Immersive 3D Render**: Floating UI elements appear directly over animals, providing a modern and professional feel.
* **Dynamic Distance Scaling**: UI elements smoothly resize or fade away based on your distance from the animal to keep your view clear.
* **Built-in Localization**: Supporting 6 languages out of the box: **English, Arabic, Spanish, French, German, and Russian**.
* **Advanced Rarity System**: Animals are categorized into **Rare, Epic, or Legendary** with distinctive shimmering visual effects.
* **Real-time Vital Stats**: Tracks HP (Health Points) and star-quality ratings dynamically.
* **Superior Optimization**: Runs at **0.00ms - 0.01ms**, ensuring no impact on your server's performance.
* **Framework Independent**: Fully **Standalone**. Works with VORP, RedEM:RP, RSG, or any base server.

## 📥 Installation Guide

{% stepper %}
{% step %}

### Script Deployment

1. Download the resource and extract it.
2. Move the `gw-Animals` folder to your server's `resources` directory.
3. **Note:** Keep the folder name as `gw-Animals` to ensure assets load correctly.
   {% endstep %}

{% step %}

### Basic Configuration

Open [shared/config.lua](broken://pages/890842ac97081d8d03af88551738ed5134766c16) to adjust the settings to your liking:

* **Config.Language**: Change the default language (e.g., `'EN'`, `'AR'`, `'ES'`).
* **Config.FOVCheck**: Set to `true` to only show the UI when you are looking directly at the animal.
* **Config.FOVRadius**: Adjust how precise your aim must be to trigger the UI.
  {% endstep %}

{% step %}

### Server Integration

Add the following line to your `server.cfg` file:

{% code title="server.cfg" %}

```cfg
ensure gw-Animals
```

{% endcode %}
{% endstep %}
{% endstepper %}

## ⚙️ Customization (Development)

### Adding New Species

You can easily expand the animal database in [shared/config.lua](broken://pages/890842ac97081d8d03af88551738ed5134766c16). Navigate to your active language and add the animal's model hash:

{% code title="shared/config.lua" %}

```lua
[`a_c_panther_01`] = { 
    name = "PANTHER", 
    desc = "PREDATORY CAT FOUND IN LEMOYNE. HIGHLY DANGEROUS." 
},
```

{% endcode %}

### Adjusting Textures & Design

All UI assets are located in the `ui/` folder. You can modify the CSS and HTML files to perfectly match your server's aesthetic, as these files are unencrypted for your convenience.

## 🆘 Troubleshooting & Tips

<details>

<summary>UI Not Appearing?</summary>

Ensure you have `Config.FOVCheck = false` if you want it to show without looking directly at them, or check your `FOVRadius`.

</details>

<details>

<summary>Performance</summary>

If you see any flickering, ensure your server artifacts are up to date, as this script uses advanced world-screen transformation.

</details>

{% hint style="warning" %}
This script is a standalone visual enhancement. It does not overwrite hunting or skinning systems, making it compatible with every hunting script on the market.
{% endhint %}

*Created by GW STUDIO*


---

# 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://gw-studio-1.gitbook.io/installation/gw-animals-install-guide.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.