Garry's Mod.

Scripts on Garry's Mod servers (roleplay, sandbox, game modes), through one server addon.

This page is generated from the SDK's platform registry (sdk/environments.json) and the adapter's SETUP.md. The Garry's Mod page on the site is the short version.

How it runs

One server addon, scriptgo, carries the core and runs it in the server's GLua, ticked on the Think hook. scriptgo pack --target garrysmod turns each package into its own addon.

The adapter's code and README: sdk/adapters/garrysmod.

Set up

1. Build the runtime addon, optionally with resources bundled in:

   bashCopy

   node sdk/adapters/garrysmod/build.mjs --with sdk/packages/sg_inventory --with sdk/packages/sg_eventbus

   or pack each resource as its own addon (the runtime addon comes with it, --no-runtime leaves it out):

   bashCopy

   scriptgo pack sdk/packages/sg_inventory --target garrysmod   # -> dist/garrysmod/scriptgo_sg_inventory/ + dist/garrysmod/scriptgo/

2. Copy the folders into the server's garrysmod/addons/ and restart the map. Every resource with auto_start true starts once the map has loaded, dependencies first. Server owners can also put resources in garrysmod/data/scriptgo/resources/<name>/.

3. Optional garrysmod/data/scriptgo/config.json:

   jsonCopy

   {
     "resources": { "sg_inventory": { "slots": 30 } },
     "permissions": { "admin": ["command.giveitem"], "76561198000000000": ["shop.*"] }
   }

   Permissions also come from superadmin and, with an admin mod such as ULX or SAM, from the CAMI privileges scriptgo.<name>.

4. Licensed packages call the SCRIPT//GO API at https://api.scriptgo.dev. To use another one (a local API in development), set scriptgo_api in server.cfg (scriptgo_api "http://localhost:4100"). An API on a loopback or private address also needs -allowlocalhttp on the srcds command line.

Only the server side runs: client scripts are not executed yet. Keep sv_hibernate_think 1 if resources must keep running while the server is empty. Resource commands are typed in chat as /name or !name; the server console has scriptgo, scriptgo restart <name> and scriptgo run <command line>.

To check a resource on your own server folder (a copy, not a live server):

scriptgo verify <resourceDir> --env garrysmod --gmod-server <folder with srcds.exe>

The server itself is the free Garry's Mod Dedicated Server (Steam app 4020), installed with SteamCMD and an anonymous login: steamcmd +force_install_dir <dir> +login anonymous +app_update 4020 validate +quit. On Windows it takes about 7 GB.

Capabilities

What the adapter provides. See SDK and capabilities for what each one is.

Protection

Licence check and signed releases. The host runs plain script, so its operator can read what it loads: no code-secrecy claim.

See Protect your work for what protection does and does not do.

Assets

Maps, models, textures, sounds and other files players download. See Selling assets.

Run on a dedicated server (srcds): every packed file was found by the engine and added to the download list. No client was run.

Asset escrow: Not feasible: GMod clients do not load server-sent binary modules.

The platform's own rules

The developer allows selling mods you own, outside the Steam Workshop.

This is the platform's rule, shown as information: whoever runs a script there answers for following it. It does not change what can be sold on SCRIPT//GO. See the rules.

Limits

• Server side only: client scripts (HUD, Derma) need a game client and are not run yet.
• Verified on the Windows dedicated server (public branch, 32-bit LuaJIT 2.0.4 and 64-bit LuaJIT 2.1), headless, with a bot as the player; Linux servers and real Steam players are not measured yet.
• An empty server hibernates and stops ticking unless sv_hibernate_think is 1.
• CAMI is implemented but not yet run with a real admin mod.

Real runs

Each row is a scriptgo verify run on Garry's Mod itself, not on a mock or an emulator: the package started there and its own tests reported back. Rows marked probe are SCRIPT//GO's conformance probes, which exercise the runtime and are never published as packages. See how a status is earned.