Introduction

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

▸ Compatibility ▸ Addons

▸ Compatibility ▸ Gamemodes

▸ ▸ About

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.

▸ Features

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

• Activation options include the chat-command !binds, the F6 key, as well as console commands.

  • Can also be enabled on player join.

• 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