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

![](https://4026831523-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWb78SmVknOFUUrfIEr%2F-MWcqfzezSyWdkfzAbow%2F-MWcuGiecBPVUYNzAwr_%2F920x260.png?alt=media\&token=5b5118b7-da14-4f7f-ba0a-79722300577f)

## ▸ Compatibility ▸ Gamemodes

<img src="https://4026831523-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWb78SmVknOFUUrfIEr%2F-MWbTbgkFF6aZIdq5579%2F-MWbTtcq3pxbyCAiseKp%2Fgm_darkrp.png?alt=media&#x26;token=34d712e1-f6d1-4744-9f7b-a573eccecc26" alt="" data-size="original"> <img src="https://4026831523-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWb78SmVknOFUUrfIEr%2F-MWbTbgkFF6aZIdq5579%2F-MWbU65ZPqSgqIVBPnez%2Fgm_hogwartsrp.png?alt=media&#x26;token=a995bea4-9038-4c60-9b51-ab7912257fd8" alt="" data-size="original"> <img src="https://4026831523-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MWb78SmVknOFUUrfIEr%2F-MWbTbgkFF6aZIdq5579%2F-MWbU9YPf19vSh0Lax1m%2Fgm_starwarsrp.png?alt=media&#x26;token=dbcacb19-5886-4d07-8b51-f00c2ad1af8d" alt="" data-size="original">&#x20;

## ▸ About

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.


---

# 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://amethyst.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.
