Introduction
This documentation serves the purpose of helping server owners install, setup, and use your new copy of this script.
Last updated
This documentation serves the purpose of helping server owners install, setup, and use your new copy of this script.
Last updated
![YL-lang]](https://img.shields.io/badge/language-lua-2A61CE.svg?logo=lua){kind=icon}
![YL-Type]](https://img.shields.io/github/manifest-json/description/im-richard/rlib.svg?color=D84B4B&filename=manifest%2Famethyst%2Fmanifest.json&label=type)
![YL-Ver]](https://img.shields.io/github/manifest-json/v/im-richard/rlib.svg?filename=manifest%2Famethyst%2Fmanifest.json&label=ver)
![YL-Req]](https://img.shields.io/github/manifest-json/libreq/im-richard/rlib.svg?color=288A51&filename=manifest%2Famethyst%2Fmanifest.json&label=rlib)
![YL-Updated]](https://img.shields.io/github/manifest-json/updated/im-richard/rlib.svg?color=D84B75&filename=manifest%2Famethyst%2Fmanifest.json&label=last)
![YL-ID]](https://img.shields.io/github/manifest-json/script/im-richard/rlib.svg?color=D8714B&filename=manifest%2Famethyst%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){kind=icon}
Amethyst is an F4 menu designed for RP-based gamemodes, including DarkRP, HogwartsRP, and StarwarsRP. It allows your players to switch between jobs that you provide on your server. As an F4-menu; this means that your players will use this to pick between your server's various jobs, buy entities, shipments, food, and more with a simple interface that lists everything as clean as possible.
Included with all of the typical functions of an F4 menu; this addon also has a Theme system which allows your players to choose between various different color schemes. Server owners can also modify these themes using the provided theme files; and also offer players special themes that can be given strictly to donator roles, admins, etc.
Players can also keep track of statistics on the addon's front dashboard; which displays numerous stats including damage taken, job switches, steps taken, items used, times crouched, bullets fired, and much more. These statistics are saved for each player; and will carry on where left off when a player re-connects to the server again.
Garry's Mod built-in achievements can also be tracked via the addon's front dashboard. All achievements built into Garry's Mod will be displayed with an appropriate icon; and an indicator which shows what achievements a player has completed, and which ones are remaining.
This addon also includes network website functionality which allows the server owner to advertise their official website, donation page, network rules, community forums and more. A special Twitch panel also allows server owner's to advertise their official Twitch channel within the interface.
