# 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%2Fpirithous%2Fmanifest.json\&label=type)![YL-Ver\]](https://img.shields.io/github/manifest-json/v/im-richard/rlib.svg?filename=manifest%2Fpirithous%2Fmanifest.json)![YL-Req\]](https://img.shields.io/github/manifest-json/libreq/im-richard/rlib.svg?color=288A51\&filename=manifest%2Fpirithous%2Fmanifest.json\&label=rlib)![YL-Updated\]](https://img.shields.io/github/manifest-json/updated/im-richard/rlib.svg?color=D84B75\&filename=manifest%2Fpirithous%2Fmanifest.json\&label=last)![YL-ID\]](https://img.shields.io/github/manifest-json/script/im-richard/rlib.svg?color=D8714B\&filename=manifest%2Fpirithous%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://153650087-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MOQZiOKV18NkkUtyHTF%2F-MOY85zcRpHptANZ-prn%2F-MOY9kABJy3aqgP2v6bF%2F920x260.png?alt=media\&token=ef74f7e7-9161-4357-b110-7b9636752894)

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

**Pirithous** is a help-screen type interface which displays an interactive on-screen keyboard. Players can hover each key to see what server-side functionality is assigned to that specific key. Certain keys are also clickable (if configured that way); which can display the interface assigned to that key.

As an example; if the server owner has Point Shop installed and assigned to the F3 key; the on-screen keyboard will display what is assigned to F3, as well as helpful information which explains the function of that key. The player can click the on-screen keyboard and open Pointshop.

This script also includes network-related navigation buttons which will open specifically configured websites such as your network's Donation website, steam workshop collection, official website, forums, etc. It also has a button for displaying your network's rules; which supports both a configured website, or you can drop your very own text-based rules in for players to read.

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

* **Interactive keyboard** displays all keys on a standard keyboard

  * Hovering each key allows a player to see what is bound to that key
  * Color-coded depending on the type of action.
    * **Red**:         Moving character around (action keys)
    * **Blue**:        Reload, use item, Q-menu
    * **Green**:     Console, scoreboard, escape screen, voice-chat
    * **Purple**:    DarkRP F keys (F1, F2, etc)
  * Colors can be customized for each key
  * Certain keys can be clicked on to perform the action (access pointshop, f4, etc)
  * Automatically detects addons such as **Pointshop 1/2**.
  * Keys can be programmed in config to perform any action / activate other addons.

* **On-Join setting** makes the interface appear for a player when they first join the server so they can get familiar with all of the binds before they play.<br>

* **Activation** options include the chat-command **!binds**, the **F6** key, as well as console commands.
  * Can also be enabled on player join.<br>

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

* **Admin Mod Support & Permissions**

  * Supports admin mods: **ULX**, **ServerGuard**, **xAdmin**, and **SAM**.

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://pirithous.rlib.io/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.