> For the complete documentation index, see [llms.txt](https://5scripts-1.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://5scripts-1.gitbook.io/docs/assets/5s_zombies/install.md).

# Install

{% hint style="info" %}
**Build Compatibility**

This script works on **most FiveM servers**. We include a free compatibility pack for older builds - so no matter what build you're on, you're covered.

* **Build 3570+** - Everything works out of the box. No extra steps needed.
* **Build 3258, 3407** - All features work, including zombie combat animations. Just start `5s_zombies_compat`.
* **Build 2944, 3095** - Works with the compatibility pack. Zombie combat animations are not available on these builds because they need game files added in build 3258. Zombies will still fight, but they will use default GTA V melee animations like any other ped instead of custom zombie animations.
* **Below 2944** - Not tested. The script may work, but we can't fully guarantee it.
  {% endhint %}

{% hint style="info" %}
**Not using ESX, QBCore, or QBox?** 5s\_zombies runs on any framework, or standalone. See [Standalone](/docs/assets/5s_zombies/standalone.md).
{% endhint %}

## 1. File Installation

Copy the following folders into your server's `resources` directory:

* `5s_zombies`
* `5s_lib` - Core library required by this script. Copy its folder too, not just `5s_zombies`.
* `5s_zombies_compat` (only needed for builds older than 3570)

{% hint style="warning" %}
`5s_lib` is a **separate resource** that ships alongside `5s_zombies`. You must copy its folder into `resources` as well - the script will not start without it. If you already have `5s_lib` from another 5scripts resource, make sure it is up to date.
{% endhint %}

## 2. Server.cfg

Add these lines to your `server.cfg`:

```cfg
ensure 5s_lib
ensure 5s_zombies
```

> **Note:** `5s_lib` must start before `5s_zombies`.

### Game build

You should use build **3570 or newer**, if you use earlier build please use compatibility pack.

Set the game build in your `server.cfg` with `sv_enforceGameBuild`. It can only be set at startup, not changed while the server is running. We recommend **3570 or newer**:

```cfg
sv_enforceGameBuild 3570
```

For the full list of build numbers see the [FiveM server commands docs](https://docs.fivem.net/docs/server-manual/server-commands/). On builds older than 3570, also start the compatibility pack (next step).

## 3. Compatibility Pack

If your server build is **older than 3570**, add one more line:

```cfg
ensure 5s_zombies_compat
```

This resource is included with your purchase. It adds all the models and animations your server needs. On build 3570+ you can skip this.

What's inside the compatibility pack:

| Category            | Contents                                                                                                                                                                                                      |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Ped models**      | `G_M_M_Zombie_01`, `G_M_M_Zombie_02`, `G_M_M_Zombie_04`, `G_M_M_Zombie_05`, `G_F_M_UndeadMage`, `IG_Gustavo_02`, `IG_Skeleton_01`, `IG_Zombie_DJ_01` (with textures, `_p` pristine variants where applicable) |
| **Animations**      | Zombie combat (core, taunts, variations), movement (core, strafe), spawn sequences (runner, shambler), summoner ritual (female, male)                                                                         |
| **Clip sets**       | `clip_sets.xml` - animation clip sets for zombie movement                                                                                                                                                     |
| **Props & objects** | Zombie staff (`m24_1_prop_m41_zombiestaff_01a`) and 50+ props used by special zombie types                                                                                                                    |
| **Metadata**        | `peds.meta` with all zombie ped definitions, object type definitions (`.ytyp`)                                                                                                                                |
| **Expressions**     | Facial expressions for zombie peds (`g_m_m_zombie_02.yed`)                                                                                                                                                    |
| **Scenarios**       | Behavior trees and scenario definitions (`.ypt` files)                                                                                                                                                        |
| **Audio**           | Sound banks (`yk_survival.awc`, `yk_survival_02.awc`, `cp_survival_01.awc`), audio config (sounds, mix, amp, speech data for DLC 24-1 and 25-1)                                                               |

## 4. Dependencies

This resource needs:

* `5s_lib` - Core library
* `ox_target` or `qb-target` - For loot interaction (you can choose in config)