# Arivia

## v3.x

- [Introduction](https://arivia.rlib.io/master.md): This documentation serves the purpose of helping server owners install, setup, and use your new copy of this script.
- [Select Version](https://arivia.rlib.io/versions.md): Pick the version of Arivia that best suites your needs.
- [Showcase](https://arivia.rlib.io/showcase.md): Preview screenshots of this addon
- [Changelog](https://arivia.rlib.io/changelog.md): A descriptive list of changes made to this script
- [3.0.0.6-beta](https://arivia.rlib.io/changelog/3.0.0.6-beta.md): This is a detailed changelog for the specified release above.
- [3.0.0.5-beta](https://arivia.rlib.io/changelog/3.0.0.5-beta.md): This is a detailed changelog for the specified release above.
- [3.0.0.4-beta](https://arivia.rlib.io/changelog/3.0.0.4-beta.md): This is a detailed changelog for the specified release above.
- [3.0.0.3-beta](https://arivia.rlib.io/changelog/3.0.0.3-beta.md): This is a detailed changelog for the specified release above.
- [3.0.0.2-beta](https://arivia.rlib.io/changelog/3.0.0.2-beta.md): This is a detailed changelog for the specified release above.
- [3.0.0.1-alpha](https://arivia.rlib.io/changelog/3.0.0.1-alpha.md): This is a detailed changelog for the specified release above.
- [FAQ](https://arivia.rlib.io/faq.md): Answers to common questions and troubleshooting steps.
- [Add Food Categories](https://arivia.rlib.io/faq/add-food-categories.md): Adding custom food categories to your menu.
- [Addon Won't Show](https://arivia.rlib.io/faq/addon-wont-show.md): Steps to take if your addon will not display in-game.
- [Incompatible Addons](https://arivia.rlib.io/faq/incompatible-addons.md): Addons in this list have been deemed "incompatible" and require extra work.
- [Custom Category Colors](https://arivia.rlib.io/faq/custom-category-colors.md): Defining custom category colors.
- [Hide Unavailable Jobs](https://arivia.rlib.io/faq/hide-unavailable-jobs.md): Solutions related to seeing jobs that a player shouldn't be able to join.
- [Modified Script](https://arivia.rlib.io/faq/untitled.md): The answer you will receive if you wrote your own customizations which are not working.
- [Refunds](https://arivia.rlib.io/faq/refunds.md): Policy regarding refunds
- [Script Errors](https://arivia.rlib.io/faq/script-errors.md): If your server console is throwing errors.
- [When Are Updates?](https://arivia.rlib.io/faq/when-are-updates.md): The number one question...
- [Install](https://arivia.rlib.io/setup/install.md): This section explains the installation process. Follow the instructions step-by-step.
- [Verify](https://arivia.rlib.io/setup/verify.md): Confirm your installation with the following instructions.
- [Workshop](https://arivia.rlib.io/setup/workshop.md): Workshop collection info related to this addon
- [Docs/Web](https://arivia.rlib.io/setup/docs-web.md): This information explains the 'web' folder provided in your downloaded zip.
- [Env](https://arivia.rlib.io/configuration/env.md): Library environment file.
- [Fonts](https://arivia.rlib.io/configuration/fonts.md): Information related to modifying fonts.
- [Languages](https://arivia.rlib.io/configuration/languages.md): Information related to how this addon can be translated.
- [Settings](https://arivia.rlib.io/configuration/settings.md): Explains configuration options, paths, and general settings information
- [sh\_4\_tabs.lua](https://arivia.rlib.io/configuration/settings/sh_4_tabs.md): Settings for tabs
- [bUseModelImage](https://arivia.rlib.io/configuration/settings/sh_4_tabs/busemodelimage.md): Determines if jobs, entities, shipments, etc. should display animated models in the F4 menu; or display static images.
- [styleB](https://arivia.rlib.io/configuration/settings/sh_4_tabs/styleb.md): Determines when style that items in each slot will utilize when displaying for the player.
- [Visual Blueprints](https://arivia.rlib.io/configuration/visual.md): This section provides visual references to where certain items can be configured.
- [Binds](https://arivia.rlib.io/first-use/binds.md): Information related to interacting with the addon.
- [Console Commands](https://arivia.rlib.io/first-use/console-commands.md): Information related to addon console commands.
- [▸arivia.listjobs](https://arivia.rlib.io/first-use/console-commands/untitled.md)
- [▸arivia.getjob](https://arivia.rlib.io/first-use/console-commands/arivia.getjob.md)
- [▸arivia.setjob](https://arivia.rlib.io/first-use/console-commands/arivia.setjob.md)
- [Jobs](https://arivia.rlib.io/developers/jobs.md): This section explains job management with Arivia.
- [▸Parameters](https://arivia.rlib.io/developers/jobs/parameters.md)
- [tip](https://arivia.rlib.io/developers/jobs/parameters/tip.md): Specifies a tooltip-like popup box which will display when a player hovers their mouse over the job in the list.
- [NeedJob](https://arivia.rlib.io/developers/jobs/parameters/needjob.md): Allows you to limit a job to only be joinable if the player is currently some other job first.
- [NeedGroup](https://arivia.rlib.io/developers/jobs/parameters/needgroup.md): Allows you to limit a job to be joinable only if the player belongs to a certain usergroup.
- [▸Sorting](https://arivia.rlib.io/developers/jobs/sorting.md)
- [Entities](https://arivia.rlib.io/developers/entities.md): Provides a list of special fields available for entities
- [▸accent](https://arivia.rlib.io/developers/entities/accent.md): Specifies a custom accent color that will fill in the circle to the far right of each item / job slot.
- [▸allowed](https://arivia.rlib.io/developers/entities/allowed.md): Defines what teams are allowed to buy the entity.
- [▸customHideUnavail](https://arivia.rlib.io/developers/entities/customhideunavail.md): Forces an entity to not show in the F4 menu if CustomCheck is provided and the player does      not meet the requirements.
- [▸level](https://arivia.rlib.io/developers/entities/level.md): Assigns a certain level that a player must be in order to buy the item
- [▸prestige](https://arivia.rlib.io/developers/entities/prestige.md): Assigns a certain prestige that a player must have in order to buy the item
- [▸price](https://arivia.rlib.io/developers/entities/price.md): Defines what the price of an entity will be.
- [▸tip](https://arivia.rlib.io/developers/entities/tip.md): Specifies a tooltip-like popup box which will display when a player hovers their mouse over the job in the list.
- [Food](https://arivia.rlib.io/developers/food.md): Provides a list of special fields available for food
- [▸category](https://arivia.rlib.io/developers/food/category.md): Groups food into a particular category for better organization.
- [Categories](https://arivia.rlib.io/developers/categories.md): This section explains categories
- [▸tip](https://arivia.rlib.io/developers/categories/tip.md): Specifies a tooltip-like popup box which will display when a player hovers their mouse over the job in the list.
- [Rules](https://arivia.rlib.io/internal/rules.md)
- [Web Demo](https://arivia.rlib.io/internal/demo.md): Information for your addon's web-browser
- [Status](https://arivia.rlib.io/doc-references/status.md)

## v2.x

- [Introduction](https://arivia.rlib.io/v2.x/master.md): This documentation serves the purpose of helping server owners install, setup, and use your new copy of this script.
- [Select Version](https://arivia.rlib.io/v2.x/versions.md): Pick the version of Arivia that best suites your needs.
- [Changelog](https://arivia.rlib.io/v2.x/changelog.md): Displays the most important changes of a release.
- [2.2.1.0](https://arivia.rlib.io/v2.x/changelog/2.2.1.0.md): This is a detailed changelog for the specified release above.
- [2.2.0.0](https://arivia.rlib.io/v2.x/changelog/2.2.0.0.md): This is a detailed changelog for the specified release above.
- [FAQ](https://arivia.rlib.io/v2.x/faq.md): Answers to common questions and troubleshooting steps.
- [Add Custom Descriptions](https://arivia.rlib.io/v2.x/faq/add-custom-descriptions.md): How to apply custom descriptions to entities.
- [Addon Won't Show](https://arivia.rlib.io/v2.x/faq/addon-wont-show.md): Steps to take if your addon will not display in-game.
- [Incompatible Addons](https://arivia.rlib.io/v2.x/faq/incompatible-addons.md): Addons in this list have been deemed "incompatible" and require extra work.
- [Opening Delay](https://arivia.rlib.io/v2.x/faq/opening-delay.md): Info for issues with interface taking 0.5ms - 1s to open.
- [Material Wallpapers](https://arivia.rlib.io/v2.x/faq/material-wallpapers.md): Solutions for missing wallpaper materials
- [Modified Script](https://arivia.rlib.io/v2.x/faq/modified-script.md): The answer you will receive if you wrote your own customizations which are not working.
- [Refunds](https://arivia.rlib.io/v2.x/faq/refunds.md): Policy regarding refunds
- [Script Errors](https://arivia.rlib.io/v2.x/faq/script-errors.md): If your server console is throwing errors.
- [When Are Updates?](https://arivia.rlib.io/v2.x/faq/when-are-updates.md): The number one question...
- [v2 VS v3](https://arivia.rlib.io/v2.x/faq/v2-vs-v3.md): What's the difference?
- [Install](https://arivia.rlib.io/v2.x/setup/install.md): This section explains the installation process. Follow the instructions step-by-step.
- [Verify](https://arivia.rlib.io/v2.x/setup/verify.md): Confirm your installation with the following instructions.
- [Workshop](https://arivia.rlib.io/v2.x/setup/workshop.md): Workshop collection info related to this addon
- [Docs/Web](https://arivia.rlib.io/v2.x/setup/docs-web.md): This information explains the 'web' folder provided in your downloaded zip.
- [Settings](https://arivia.rlib.io/v2.x/configuration/settings.md)
- [sh\_config](https://arivia.rlib.io/v2.x/configuration/settings/sh_config.md)
- [Web Demo](https://arivia.rlib.io/v2.x/internal/demo.md): Information for your addon's web-browser