---
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%2Flunera%2Fmanifest.json\&label=type)![YL-Ver\]](https://img.shields.io/github/manifest-json/v/im-richard/rlib.svg?filename=manifest%2Flunera%2Fmanifest.json)![YL-Req\]](https://img.shields.io/github/manifest-json/libreq/im-richard/rlib.svg?color=288A51\&filename=manifest%2Flunera%2Fmanifest.json\&label=rlib)![YL-Updated\]](https://img.shields.io/github/manifest-json/updated/im-richard/rlib.svg?color=D84B75\&filename=manifest%2Flunera%2Fmanifest.json\&label=last)![YL-ID\]](https://img.shields.io/github/manifest-json/script/im-richard/rlib.svg?color=D8714B\&filename=manifest%2Flunera%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://211179469-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M1JhiILStiA7jDKglRZ%2F-MWSAuy1rR0gxIFE8-Bd%2F-MWSB-t5CXKTqadVYdZj%2F920x260.png?alt=media\&token=58595c5f-7c33-41ad-ab0f-909836466ee7)

## <mark style="color:red;">▸ Compatibility ▸ Addons</mark>

![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)

## <mark style="color:red;">▸ Compatibility ▸ Gamemodes</mark>

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





## <mark style="color:red;">▸ About</mark>

[_**Lunera**_ ](https://www.gmodstore.com/market/view/lunera-motd-system)is a complete MOTD _(Message of the Day)_ script which gives servers a clean and informative interface that players will see when they first connect to your server. Lunera features the ability to display server rules, terms of service, and an entire list of servers available within your network that players can connect to using the provided buttons.

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? Utilize Lunera's slide feature which allows you to post important news, as well as detailed text that the player will see as soon as they connect. 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.

This script also functions as a 2-in-1 system which can be utilized as an MOTD (message of the day), Escape Screen, or both by simply enabling the appropriate configurable options.

For a full list of features, please review the **Features** section.





## <mark style="color:red;">▸ Features</mark>

* **Escape menu** **mode** allows the addon to function not only as an MOTD (message of the day script, but also as an Escape Menu.\

* **Delay** functionality forces the MOTD to stay open for an offset period of time to avoid it from being immediately closed. Interface cannot be closed by the player until the defined time has passed.\

* **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 upgrade dates, etc. \

* **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.\

* **Terms and Conditions** that a player must accept before playing.
  * Terms only display ONCE per player through-out the lifetime of being on your server. This means no annoying box each and every time they connect or maps are changed.&#x20;
  * Disables the ability to close the MOTD until they accept.\

* **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 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.
    * Specify certain groups that don't have to view the MOTD when they connect (such as staff, donators, 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.\

* **Force open** the MOTD on any player and even specify a delay that the player must wait to expire. This ensures they read important information again.\

* **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.\

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

* **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)


* **News Ticker** to broadcast important messages to your players.
  * Supports string variables that can be added to each message to pull player/server info.\

*   **Ping Indicator**

    * Displays a warning indicator if player's ping is too high


* **Conflict Detector** tries to help the server owner if they adjust settings that may conflict with others. This helps with diagnosing issues.\

* **Multiple browser support** gives you the option to display links in either the Steam Overlay Browser, or a build in browser that matches the visual appearance of the MOTD itself.\

* **Activation Settings** allow the server owner to configure a chat command to open the MOTD, as well as a key bind.\

* **Dozens of settings** that will allow you to do even more with your MOTD script such as:
  * Force a web page to appear when the MOTD is first opened
  * Customize any color that comes with the script
  * Control slider feature orientation, timers, etc.
  * Much more
