---
description: >-
  This documentation serves the purpose of helping server owners install, setup,
  and use your new copy of this script.
---

# 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%2Fliko%2Fmanifest.json\&label=type)![YL-Ver\]](https://img.shields.io/github/manifest-json/v/im-richard/rlib.svg?filename=manifest%2Fliko%2Fmanifest.json)![YL-Req\]](https://img.shields.io/github/manifest-json/libreq/im-richard/rlib.svg?color=288A51\&filename=manifest%2Fliko%2Fmanifest.json\&label=rlib)![YL-Updated\]](https://img.shields.io/github/manifest-json/updated/im-richard/rlib.svg?color=D84B75\&filename=manifest%2Fliko%2Fmanifest.json\&label=last)![YL-ID\]](https://img.shields.io/github/manifest-json/script/im-richard/rlib.svg?color=D8714B\&filename=manifest%2Fliko%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://1064857286-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M9HtlhrC3RxjSYy2qp9%2F-MPO-U1hL31lMm-ZBwyQ%2F-MPO-eiMAtpomSTl-AmO%2F920x260.png?alt=media\&token=8abcafd4-dc7c-4573-83e6-c17b23fb1a96)

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

A multi-purpose addon that can be triggered via chat, console command or on player join. Allowing it to be utilized as an informative interface, that functions as both an escape menu, as well as an MOTD (message of the day) addon with 2-in-1 functionality.

Display your network rules either via standard text, or by directing players to a website.

Advertise your network's website, forums, donations page, steam workshop collection, and more, which are all readily available with a simple click.&#x20;

Have important information you want to announce to your players? The slides feature allows you to post important news, as well as detailed text that the player will see on the interface. Slide images support external urls which allows any image to be hosted via a web host and then referenced within the addon's configuration file.

View this addon's **Features** section for a full list.

## ▸Features

* **Escape menu** **mode** allows the addon to work as a fully-functional escape menu activated by the player with the ESCAPE key.\

* **MOTD mode** forces interface to display when a player connects to your server.
  * Ability to also turn off "Escape Menu" mode and function only as an MOTD; or leave both on for MOTD + Escape Menu.\

* **Slider / Banner** feature which allows you to display important news about the server.
  * Supports web hosted images so there's no need to use a workshop to change banner images.
  * Display a title for each headline, and a summary with the news you want to announce.
  * Supports 10+ tabs which gives plenty of room to post donation reminders, announce server upgrades, etc. \

* **Welcome greeting** displays a message in chat when a player connects to the server.
  * Includes setting to edit greeting and add your own lua if desired.\

*   **Announcements** interface comes as a _secondary option_ for owners who don't want to display the slider / banners. This is a more simple type of announcement panel which displays the title of a single announcement, and the message itself.

    * Supports .webm videos to be attached to the announcement.


*   **Live and Static Backgrounds**

    * Supports web URLs for both static and live backgrounds.
    * **Live Backgrounds** utilize **.webm** videos
    * Background source files provided in download
    * Supports standard **materials** (hosted by a Steam Workshop Collection)


*   **Rules** interface which displays when the player joins the server (if configured), or can be viewed by pressing the navigation button.

    * Rules can also be pulled up at any time by the player simply by using the chat command specified in the config.
    * Admins can also force rules to appear on a player's screen; and they will have to accept the rules in order to continue playing.
    * Rules can either be text-based or displayed via a website that you configure.


*   **Admin Mod Support & Permissions**

    * Supports admin mods: **ULX**, **ServerGuard**, **xAdmin**, and **SAM**.
    * Specify certain groups that can bypass the delay when the MOTD appears.
      * Also useful for server owners who want to give donators / VIP members the ability to bypass without the wait.
    * Force interface open for players
    * Refresh entire interface ( for development purposes / recoloring / etc )
    * Specify certain groups that don't have to view the MOTD when they connect (such as staff, donators, etc.)


*   **Server Hopper** which displays servers you own within your network. Players can connect to another server by pressing the corresponding button.

    * Confirmation dialog which ensures no accidental clicks
    * Immediate connection to server once confirmed by player
    * Supports 3 modes for button:
      * Type 1 : Icons + Text
      * Type 2 : Icon only
      * Type 3 : Text only


*   **Navigation buttons** allow you to display numerous websites including your official website, donation url, steam group, etc.

    * Supports both an integrated browser (included with script), and the option of using the Steam overlay.


*   **Header buttons** display special actions:

    * Toggle gmod console open
    * Hide custom escape menu & display default gmod menu
    * Access game settings (video, etc)


* **News Ticker** to broadcast important messages to your players.
  *   Supports string variables that can be added to each message which displays:

      * Player name / steam id
      * Server population count / Max pop
      * Network Name


* **Detailed configuration** file which allows server owner to edit almost anything included with script _(well over 100 different settings)_
  * Most features can be enabled / disabled
  * Dozens of coloring options
  * Can specify how the script behaves for players ( _show on join / motd mode / etc_ )
  * Determine how the nav menu displays for players ( _icons, text only, etc_ )
  * Toggle interface animations
  * Coloring of almost every aspect of addon
  * Developer settings for easier addon configuration
