Installation

Requirements

Required

• PolyZone - Zone creation library (GitHub (opens in a new tab))
• Your chosen framework (QB-Core, QBX-Core, or ESX)

Installation Steps

Step 1: Install PolyZone

If you don't already have PolyZone installed:

1. Download from GitHub (opens in a new tab)
2. Place PolyZone folder in your resources directory
3. Add ensure PolyZone to your server.cfg

Step 2: Download the Resource

Download legends_safezones from your Keymaster grants or the store.

Step 3: Extract to Resources

Place the legends_safezones folder into your server's resources directory.

resources/
└── legends_safezones/
    ├── fxmanifest.lua
    ├── config/
    │   └── config.lua
    ├── client/
    │   ├── client.lua
    │   └── editable.lua
    ├── server/
    │   └── server.lua
    ├── shared/
    │   └── lang.lua
    ├── locales/
    │   └── en.json
    └── ui/
        ├── index.html
        ├── style.css
        └── script.js

Step 4: Add to Server Config

Add the following to your server.cfg. Ensure PolyZone starts first:

ensure PolyZone

ensure legends_safezones

Step 5: Configure Framework

Edit config/config.lua and set your framework:

Config.Framework = "qb"  -- Options: "qb", "qbx", "esx"

Step 6: Configure (Optional)

Customize zones and settings in config/config.lua. See the Configuration page for all options.

Step 7: Restart Server

Restart your server or use the refresh and ensure legends_safezones commands.

Verification

After installation:

1. Join the server and travel to one of the pre-configured zones (e.g., Pillbox Hospital)
2. You should see the "SAFE ZONE" UI indicator
3. Try equipping a weapon - it should be automatically removed
4. Try punching - melee should be disabled

Debug Mode

To visualize zone boundaries for setup or troubleshooting:

1. Enable debug in config/config.lua:

Config.Debug = true

2. Or enable debug for specific zones:

{
    name = "MyZone",
    debug = true,  -- Enable debug for this zone only
    -- ...
}

Need help? Join our Discord (opens in a new tab) and open a support ticket!