Introduction

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

Looking for v2.x documentation? Click Here.

Don't want to run v3 beta? Download v2.

▸ Compatibility ▸ Addons

▸ Compatibility ▸ Gamemodes

▸ About

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

This addon includes two versions which customers are able to choose between. Version 2.x is the original Arivia that has been used by so many over the last few years; which still continues to get updates, fixes, etc. However, version 3 is now available as well; which is a complete re-write of the addon, but packed with even more features, a more modern design, optimizations, and all the trimming you'll need for your players to enjoy.

Since Arivia is so feature-rich; view the Features page to get a full description of everything it includes.

▸ Features

• Full category support for jobs, entities, food, vehicles, etc.

  • Ability to sort categories

  • Compatible with startExpanded parameter

  • Remembers which categories have been expanded and collapsed by players for easier organization.

  • Colorize each category from darkrp jobs / entities file

  • Supports tips which display when mouse hovered over category

• Job Favorites:

  • Players can mark a job as a favorite which will make the job appear in a "Favorites" category above all other job categories in list.

  • Icon displayed to far right of job marking it as a favorite

  • Ability to configure Arivia to handle favorites in one of two ways:

    • 1. Show favorited jobs only at the top in a "Favorites" category.

      2. Show favorited job at the top in a "Favorites" category; AND display it where it would normally be in the correct category (shows job twice).

• Quick Job Switch / Buy:

  • Each job and item include quick buy/switch button which reduces moving player's mouse around.

• Live and Static Backgrounds

  • Supports web URLs for both static and live backgrounds.

  • Live Backgrounds utilize .webm videos

  • Background source files provided in download

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

  • Rules can either be text-based or displayed via a website that you configure.

  • If text-based rules selected in config; server owner can also specify a website URL with rules that the player will see on the right of the text-based rules.

• Enhanced Workshop Management:

  • Server owner can specify any number of workshops that are associated to your server for players to see.

  • Player can see each workshop provided in the config, and click on it to view it within the Steam Overlay Browser or Integrated Browser.

  • Also includes the option to only provide a single workshop collection instead of multiple.

• 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

• Expand / Minimize left navigation panel:

  • All nav / job / item buttons will disappear and expand the entire panel that shows jobs / items fully to fit the interface width.

  • Button can be pressed again to make left-side panel re-open.

• Loadouts:

  • Jobs will display a list of entities / weapons that are given for that particular job.

  • Shows name of entity and 3D model.

• Staff Interface:

  • Displays a list of players on server that have staff ranks.

  • Each card ( staff member ) displays their name, rank, and can be clicked on to view their steam profile.

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

  • Confirmation dialog which ensures no accidental clicks

  • Immediate connection to server once confirmed by player

  • Supports 3 modes for button:

    • Type 1 : Icons + Text

    • Type 2 : Icon only

    • Type 3 : Text only

• User Job Commands (Actions):

  • Players with specialized jobs (Mayor, Civil Protection, etc) have access to a custom list of actions which can be displayed quickly:

    • General:

      • Drop Weapon

      • Drop / Give Money

      • Make Shipment

      • Sell All Doors

      • Request Gun License

    • Civil Protection:

      • Add / Remove Warrant

      • Add / Remove Wanted Player

    • Mayor:

      • Broadcast Message

      • Start / Stop Lockdown

      • Add / Remove Law

      • Place Law board

  • Detailed config allows server owner to add custom actions easily.

• Model Viewer ( MDLV ):

  • Allows players to view a model for a job / entity / weapon, etc. in a full-screen interface.

  • Player can move model around, zoom in/out, and rotate model to view it from all angles.

  • Server owner can see a full path to the model and the ability to copy it to their clipboard for easier darkrp configuration.

• Food Management:

  • Gives server owners a better way to manage Food items in-game that aren't available with darkrp configs:

    • Custom category support

    • Supports startExpanded

    • Sorting options

    • Custom descriptions from Arivia for instant changes instead of DarkRP config.

• Navigation buttons:

  • Allow players to reach websites related to your network.

  • Includes buttons for:

    • Network website

    • Donation site

    • Discord invite link

    • Steam Workshop Collection

    • Rules

• Job / Item Indicators:

  • Detailed information if job unavailable /restricted for player.

  • Custom color-coded banners for jobs / items depending on their status

  • Ability to grey out OR hide jobs / items that are unavailable (setting in config).

• Developer Tools:

  • Displays helpful tooltips for server owner's which help explain how to configure addon.

  • Jobs / items have Debug Tab which lists parameters configured in the darkrp config files. Each parameter can be clicked on and copied to clipboard to help with easier configurations and debugging.

  • Also includes the option to only provide a single workshop collection instead of multiple.

• 3rd Part Support:

  • Support for admin mods:

    • ULX

    • xAdmin

    • SAM

    • ServerGuard

  • Support for addons:

    • Advanced Leveling System

    • Prestige Leveling System

• Client-side settings menu allows players to customize their experience.

  • Option to auto-close menu after each purchase; or keep it open.

  • Enable/Disable notification system

  • Enable/Disable 3d models or use static images for each job / item

  • Toggle server admin tools, hints (server admins only)

  • Toggle debug mode (server admins only)