Home

FAQ

How do I install a binary module?

To install a binary module follow these simple steps (applies to Garry's Mod 13):

1. Name of the binary module must be prefixed with either "gmcl_" or "gmsv_" (depends on Lua realm), and must be suffixed with either "_linux" or "_osx" or "_win32" (depends on supported platform). It is also recommended to only use lowercase characters/letters.
   Valid examples:
   gmsv_another_module_linux means serverside module for Linux platform.
   gmcl_my_module_win32 means clientside module for Windows platform.
   gmsv_module_name_osx means serverside module for OS X platform.

2. Copy binary module file into the following directory (create a bin folder manually if it doesn't exist):
   Steam\steamapps\common\GarrysMod\garrysmod\lua\bin

3. Before you can use a binary module you must call require function (in appropriate Lua realm and platform) and specify the name of binary module.
   Valid example:

require("another_module")

When code from above is run, it will search for binary module called "Xanother_moduleY", where X is current Lua realm ("gmcl_" on CLIENT and "gmsv_" on SERVER) and Y is operating system platform ("_linux" on Linux platform, "_osx" on OS X platform, and "_win32" on Windows platform).