▸Addon Won't Show

Instructions for handling situations where the addon will not display at all on the server.

▸Incompatible Addons

View a list of Workshop Addons that are deemed incompatible with this addon.

▸Modified Script

The answer you will receive if you wrote your own customizations which are not working.

▸Refunds

Policy regarding refunds

▸Script Errors

Instructions for handling situations where the addon throws errors in the server console.

▸When Are Updates?

The main question I always get asked.

It is common for customers to have basic issues with a script; immediately assume it is the script's fault, and request a refund before any type of communication or ticket has been created. Then after initial troubleshooting; it ends up being a bad installation, or a user-error.

For this reason is why refunds are not granted simply upon request if you report an issue with the script. The developer will request that you submit a ticket with the following information:

• Any errors in your server-side console

• Verifying your installation path

• Confirming the script works without any initial settings being modified

If the above points appear to be fine; then the developer is going to request additional information related to your server itself so that the developer can take a look personally.

Should bugs with the script be present; the developer will release updates addressing the issue.

Because you are dealing with digital items; a developer cannot remove your downloaded copy of an addon. Therefore, a refund is approved in instances where no other possible solution can be provided to address your issue in a proper amount of time; as long as the issue is with the addon itself, and NOT because of user-errors. Which will be determined by the developer after you create your initial support ticket.

The most recent update is listed at the top, and the oldest at the bottom

▸ Errors occur after you edited the config files?

If yes; go back to the edited config file and remove the edits you have made and attempt to restart the server and check for errors.

▸ Errors occur with no edits?

Make sure you followed the procedures properly.

▸ Errors occur with good install and no edits?

Write down the error and contact the developer on

If you modified this script and are now having issues getting your changes to function properly; this is an issue you will have to troubleshoot yourself.

I do not provide support for modifications to the base script.

This policy does NOT include changing settings that come out-of-box; which you will still receive support for.

▸ Overview

• [ + ] added scaling for various monitor resolutions

• [ + ] added support for various stamina addons

• [ + ] added theme system

• [ ^ ] primary hud element now hides when chat opened

• [ ^ ] utime displays time in new format + additional settings

• [ ^ ] updated interface URL links to new server

• [ ^ ] deprecated old autoloader code no longer in use

• [ ^ ] rewrote configuration files with detailed commenting

• [ ^ ] config files broken up individually and placed in sh/cfg/ folder

• [ ^ ] modified how headhud's groups + nicknames feature works

• [ ^ ] all translatable strings moved to sh/cfg/sh_cfg_lang.lua

• [ - ] removed / simplified overly-complicated settings

▸ Official List

The following workshop addons have been known to cause issues with this script after being reported to the developer. In order to get this addon functioning properly; please review the chart below to see what is causing the incompatibility.

Certain workshop addons are coded poorly, and the Steam Workshop does not have "Coding Standards". In order to correct the addons below; it would be required to modify the Workshop addon itself which is not good practice for us. We do not want to modify other scripts to behave differently than what you expect them to behave.

▸ Check Addons

From time to time; certain addons from the Steam Workshop may conflict with purchased addons from Gmodstore.

To eliminate the possibility of a Steam Workshop addon breaking this addon; please complete the following:

• Open your server's Hosting Control Panel (gmc, crident, etc).

• Locate the Startup Parameters section.

• REMOVE the steam workshop collection id associated to the server

• Save your server settings with workshop id removed

• Restart the server and then join

• Check to see if the addon now works

If you removed the workshop collection and your addon does NOT work; Submit a Ticket to the developer.

If you removed the workshop collection and your addon now works; you will need to use Process of Elimination to figure out which addon is causing a conflict.

▸ Process of Elimination

If you have verified that this addon does not function unless you remove your Steam Workshop Collection; then you will need to figure out which addon is causing conflicts. Again, this is usually not a developer issue related to addons on Gmodstore, but improperly coded addons that are provided on the workshop that have no quality control in place.

You will need create an additional Steam Workshop Collection titled something such as Test; and apply that new workshop id to your server; replacing your official collection.

Add a small group of addons to begin with (roughly five (5) at a time) to your new test collection, and then restart your server.

When the server is back online, join the server and test this addon to see if it starts to function. If it does, you will need to narrow down which of the five newest addons may be causing the conflict by removing one of the five; one by one and doing a restart.

If the issue persists after five are added; then add an additional five and continue this process.

It is tedious, and takes time especially on servers which a large list of subscribed workshop items, but it is the only way to determine which addon is conflicting.

Once you find the conflicting addon; contact the developer of this gmodstore addon to see if some type of work-around can be developed.

▸ Location

▸ Parameters

str prefix prefix added to front of id_name string

str id_name name used to call font entry

str font name of font used

int size size for font

int weight font weight ( 100, 200, 300, 400, 500, 600, 700, 800 )

bool shadow add shadow casting to the font

bool extended allow font to display glyphs outside Latin-1 range. unicode code points above 0xFFFF are not supported.

bool symbol enables the use of symbolic fonts such as Webdings

▸ Structure

Each font has the following structure:

An example of the structure being used in a font:

▸ Saving

After changing the settings for a font, or adding your new font; you must execute the console command:

▸ Notes

▸Location

▸Add Language

• Copy the lua\modules\hudhive\lang\en.lua file

• Rename copied en.lua file to your own language

  • Example: lua\modules\hudhive\lang\ru.lua ( russian )

• Open the new language file in a text editor.

• Locate the line:

  • mod.language[ 'en' ]

• Change the line to your new language:

  • mod.language[ 'ru' ]

• Translate all of the strings to your own language.

▸Default Language

• Open the folder lua\modules\hudhive\lang\

• Find the filename for the language you want to make as your default

• Open lua\modules\hudhive\cfg\sh_0_lang.lua

• Change en to your own language's filename (without the .lua at the end)

Your language settings file should look like the following:

Restart the server for changes to take effect.

▸Switching Language

You can switch languages in-game on-the-fly by typing !lang in chat.

▸ About

Settings files contain a wide variety of values that can be changed and deal with how the overall addon will look and perform. These files are typically where you will turn certain addon features on/off, change feature settings, modify the colors for any user-interface provided, etc.

▸ Location

lua\modules\hudhive\cfg\*

▸ Files

I cannot give ETAs on when updates are released. I am constantly working on adding new features, as well as bug fixes. On top of that, I have a large list of scripts that also still receive regular updates. If I give an ETA on an update release; I cannot stick to that schedule because something can arise that causes the update to be delayed; therefore, I'll never give a time / date of a release.

After completing the installation of rlib and your addon; you can check for a succesful installation by performing the following steps:

▸ Verifying rlib

Open your server-side console and execute the following command:

If rlib is installed and running properly; your console should output:

rlib » manifest

    Version    » v3.6.1.1 ( 09.29.2022 )
    Author     » Richard
    Docs       » https://docs.rlib.io/
    Uptime     » 16h 20m
    Addons     » 6 (base, builderx, hudhive, identix, linx, workshop)

Of course, your list of addons and uptime will be different. However, by running that command, you should get an output.

If you receive the following error; then rlib is NOT installed correctly.

Unknown command "rlib.modules"

For instructions on installing rlib; you can visit one of the following links:

• HudHive Documentation ▸ Install

• Rlib Documentation ▸ Install

▸ Verifying addon

To confirm the installation of your addon, open your server-side console and execute the following:

rlib.modules

The following information should appear in your console:

[rlib] Active Modules
-----------------------------------------------------------------------------------
Module               Version           Author          Description
-----------------------------------------------------------------------------------
Base                 2.0.0.0 stable    Richard         base module
Builder-X            2.1.0.0 stable    Richard         build & pvp mode
Hudhive              2.0.0.0 stable    Richard         darkrp hud
Identix              2.6.0.0 stable    Richard         name & profile system
Linx                 2.4.0.0 stable    Richard         escape screen
Workshop             2.0.0.0 stable    Richard         workshop content downloader
-----------------------------------------------------------------------------------

Your list of addons will be different. However, the name of the addon that you've installed should appear in the list.

If you cannot find the addon's name, please review the Installation Instructions.

▸ Location

You can access the theme files for this addon by going to

lua\modules\hudhive\themes\

▸ Modifying Colors

Colors and various other settings are stored in convars when the player connects to the server.

If you wish to modify a theme and change the colors; you will need to open one of the theme files by going to the location provided above.

Find the name of the setting you wish to modify, an example is provided below:

{
    sort            = 450,
    b_visible       = true,
    id              = 'hudhive_rp_clr_utime_val_txt',
    name            = 'Utime label Color',
    desc            = 'Color for utime value text',
    class           = 'hexa',
    values          = { hex = 'FFFFFF', alpha = 255 },
},

The above example is what defines the text color for utime.

You can change the color by modifying the hex value specified as { hex = 'FFFFFF', alpha = 255 }

Once you make your desired change, you will need to connect to your server as a player. The old color should still be cached as a convar and the change will not appear until you open your player console ( by pressing ~ ) and type the command:

hudhive.debug.th.reset

Once entering the above command, all old convars will be overwritten with the values stored in the theme file, and the new change should appear on your hud.

▸ Changing Themes

Players are given the ability to change themes on-the-fly. You can do this one of three ways:

1. Clicking the located on the hud itself.

2. Open player chat and type the command !themes

3. Open the player console ( press ~ ) and type hud.themes

▸ Default Theme

The Frost theme is the default theme.

You can modify which theme is the default for new players.

Open lua\modules\hudhive\cfg\sh_2_themes.lua and modify the setting:

cfg.themes.default          = 'frost'

You must choose a valid theme name to become the default. If you do not put in a valid name, the default theme will not change.

▸ Forcing Theme

You can also force which theme is used by all players.

Open lua\modules\hudhive\cfg\sh_2_themes.lua and modify the setting:

cfg.themes.force_theme      = true

By setting the value above to true; all players connecting to the server will be forced to use the default theme.

▸ Install rlib

• Go to https://get.rlib.io/ and download the latest version of rlib.

• Extract the downloaded zip to your computer

• Create a new folder on your gmod server called rlib

  • Example: garrysmod/addons/rlib/

• Upload the extracted rlib zip files to the newly created folder.

  • Ensure you are uploading the files to match the following file structure:

📁 garrysmod 📁 addons 📁 rlib 📁 lua 📁 materials 📁 resource

• Restart server

• As the server restarts, view the console for errors.

  • If you see errors, contact the developer with a list of them.

  • If you do not see errors, proceed forward

• Connect to your gmod server and spawn in.

• Make sure you have superadmin access on the server. If you are using an admin mod; do one of the following sub-points below:

  • ULX: Type in server console: ulx adduser yourname superadmin

  • SAM: Type in server console:sam giverank yourname superadmin

  • SGUARD: Type in server console: serverguard_setrank yourname superadmin

• Once you have superadmin; type ?setup in chat.

• You have completed the setup. Proceed to the Install Addon section below.

▸ Install addon

• Go to https://gmodstore.com/ and download a fresh copy of your purchased script.

• Extract downloaded zip to your computer

• Create new folder on gmod server with the name of the addon

  • Make sure the folder name contains NO SPACES, NO SPECIAL CHARACTERS, and NO CAPS

  • Example: garrysmod/addons/hudhive

• Upload the extracted addon files to the newly created folder

  • Ensure you are uploading the files to match the following file structure:

📁 garrysmod 📁 addons 📁 hudhive 📁 lua 📁 materials 📁 resource

• Restart the server

• As the server restarts, view the console for errors.

  • If you see errors, view Script Throwing Errors

  • If you do not see errors, proceed forward

• Try to activate your addon.

  • View Binds page for list of methods available for this script.

• If you see the script actively working, then you are finished with the setup.

▸ What's Next?

Want to subscribe to this addon's steam workshop collection? Visit the Workshop page.

Curious about the /docs/web folder provided in your zip? Visit the Web part of this guide.

Each addon has a workshop collection associated to it. The workshop content delivers materials, fonts, and sounds to your users so that they'll be able to see everything within the addon.

These scripts include a workshop auto-mounting system which will force each connecting player to mount the required workshop for this addon; however, if you need the workshop for other purposes or to add to your server's workshop collection; you can get it below

▸ Verify Install

Verify that you've followed the instructions on the page. Ensure that this includes both a good installation of rlib AND the addon itself. You can also follow the steps on the Verify page to ensure that both of these are functioning properly.

▸ Revert Config Changes

If you have made changes to the configuration and cannot get the addon to show; revert those changes. Try installing a fresh copy of the addon without any changes to determine if the changes to the config are to blame or if you are having issues elsewhere.

▸ Use Latest Versions

Ensure that you are using the latest version of both rlib AND the addon you are trying to install. allows developers to post multiple versions of an addon, and sometimes customers can accidentally click if downloading the addon from the Versions tab. Double-check your installed version.

▸ Check For Incompatible Addons

If you are experiencing issues with this addon; ensure first that it is not conflicting with other addons. Any addons that have been installed from the Steam Workshop MUST be checked first. This developer cannot control the quality of code for addons distributed via the Steam Workshop and most reported situations involve a Workshop addon that is not coded properly and has not been updated in years.

For more detailed instructions; view thepage.