# Introduction

![YL-lang\]](https://img.shields.io/badge/language-lua-2A61CE.svg?logo=lua)![YL-Type\]](https://img.shields.io/github/manifest-json/description/im-richard/rlib.svg?color=D84B4B\&filename=manifest%2Fbuilderx%2Fmanifest.json\&label=type)![YL-Ver\]](https://img.shields.io/github/manifest-json/v/im-richard/rlib.svg?filename=manifest%2Fbuilderx%2Fmanifest.json)![YL-Req\]](https://img.shields.io/github/manifest-json/libreq/im-richard/rlib.svg?color=288A51\&filename=manifest%2Fbuilderx%2Fmanifest.json\&label=rlib)![YL-Updated\]](https://img.shields.io/github/manifest-json/updated/im-richard/rlib.svg?color=D84B75\&filename=manifest%2Fbuilderx%2Fmanifest.json\&label=last)![YL-ID\]](https://img.shields.io/github/manifest-json/script/im-richard/rlib.svg?color=D8714B\&filename=manifest%2Fbuilderx%2Fmanifest.json\&label=id)![YL-hits\]](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fim-richard%2Frlib\&count_bg=%235A3DC8\&title_bg=%23555555\&title=hits\&edge_flat=false)

![](https://76509209-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MQ057EIpmXJtZ_m1vrl%2F-MSzZ4cCU2nzR5yZ-Hov%2F-MSzZ9Yo5bSNZkuVOxp2%2F920x260.png?alt=media\&token=bf7ffe1c-179a-45c2-a117-f99a644ba49d)

## ▸Compatibility ◾ Addons

![ULX](https://g.rlib.io/gms/badges/addons/86/u.png) ![XAdmin](https://g.rlib.io/gms/badges/addons/86/x.png) ![SAM](https://g.rlib.io/gms/badges/addons/86/s.png) ![ServerGuard](https://g.rlib.io/gms/badges/addons/86/sg.png)

## ▸Compatibility ◾ Gamemodes

![All Gamemodes](https://g.rlib.io/gms/badges/gm/86/gm_all.png)

## ▸About

**Builder-X** allows server owners to support two different groups of players on the same server; **Builders** and **PVPers**. Players are given the ability to switch between Build or PVP mode; giving builders special permissions so that they can play without fear of being killed.

With a wide variety of settings that can be customized; server owners can give builders such things as automatic immunity from damage, as well as noclip. Builders will also be stripped of any weapons they currently possess, and will be given back once the player switches from Build mode to PVP mode.

On top of these restrictions; a built-in damage / punishment system is also available, which monitors for **Kills** or **Damage** of players; depending on which type is set by the server owner. If a builder does damage to other players while in build mode; they will be warned, as well as a notice being sent to the server staff. If the builder continues to do damage; they will be kicked from the server. The server owner can determine which type to monitor; and set the threshold for each type. User groups can also be set as protected from the punishment system (such as staff) in the configuration files.

## ▸Features

* Supports two modes: **Build Mode** & **PVP Mode**.<br>

* **Build Mode** can do any of the following:

  * Ensure that a player cannot take damage
  * Strip and save all player's current weapons until they return to PVP mode
  * Monitor for damage of other players **( see punishment detection )**
  * Restrict a builder from spawning weapons / entities
  * Place a halo (glow) around builders on the map to indicate the mode they are playing under
  * Fully restore their health once they switch to Build Mode
  * Give special loadouts to players who enter Build Mode.
    * **Default**: *weapon\_physgun, gmod\_tool, gmod\_camera*
  * Allow players to have **NOCLIP** ability
    * Can be given automatically when player joins Build Mode *OR*
    * Can be activated by the player when needed using **!fly** chat command
  * Ability to force respawn after player leaves Build Mode

* **Weapon / Tool Stripping:**

  * Players who enter build mode will have their current weapons & tools stored to a temp save.
  * Player will enter build mode and be given whatever is listed in the Build Mode loadout list
  * Once player returns to PVP mode; they will be given back all tools / weapons they had prior to switching to Build Mode

* **Anti-Abuse** system:
  * Players must wait X seconds before switching between modes back and forth
  * If player takes damage; they must wait X seconds before changing modes to prevent PVP abuse<br>

* **Damage Blocking**:

  * Script comes with numerous levels of damage blocking
  * Stops a player in build mode from taking any type of damage what-so-ever
  * Includes **Advanced Damage Mode**
    * Ensures that players in Build Mode cannot hurt PVPers, and PVPers cannot hurt Builders

* **Whitelist Spawning**:
  * Server owner can restrict players in Build Mode from spawning SENTs & SWEPs (entities & weapons).
  * If SENT and SWEP spawn restriction enabled; player can only spawn what is configured in the whitelist table.
  * This can be used on top of other restriction addons installed on your server.
  * Can be turned off completely so that other addons can manage this aspect.<br>

* **3rd Part Support:**
  * Support for **admin mods**:
    * [**ULX**](https://ulyssesmod.net/downloads.php)
    * [**xAdmin**](https://www.gmodstore.com/market/view/xadmin-2-admin-mod)
    * [**SAM**](https://www.gmodstore.com/market/view/sam)
    * [**ServerGuard**](https://www.gmodstore.com/market/view/serverguard)
  * Support for **addons**:
    * **Pointshop Airdrops DLC**
  * Admin Mod **Permissions:**

    * Get / Reset **Damage punishment counter**
    * Force set **mode** on player
    * Force interface open for player
    * Force interface refresh for player

* **Binds & Activation**:

  * Interface can be activated using any of the following:
    * Keybind ( default: **F8** )
    * Chat ( **!mode** )

* **Live and Static Backgrounds**
  * Supports web URLs for both static and live backgrounds.
  * **Live Backgrounds** utilize **.webm** videos
  * Background source files provided in download