Documentation

Follow these steps to seamlessly connect your game server to the Nexus Maps platform.

Quick Start Installation — Garry's Mod

Step 1Purchase a Subscription

To get started, you'll need an active Nexus Maps subscription.

Step 2Go to Your Dashboard

Once subscribed, navigate to your Nexus Maps dashboard.

Step 3Open Settings

Inside the dashboard, locate and press on the 'Settings' tab to manage your account and servers.

Step 4Generate an API Key

Create a new API key. This key will securely link your game server to the Nexus Maps platform.

Step 5Install the Server Addon

Download and install the official Nexus Maps addon onto your Garry's Mod server.

Step 6Install Workshop Requirements

You must also install the required Workshop addon on your Garry's Mod server for the platform to function correctly.

Step 7Open In-Game Configuration

Join your server and type nexus_config in the client console. In the menu that appears, press on 'Nexus Maps'.

Step 8Enter Your API Key

Copy the API key you generated in Step 4 and paste it into the configuration menu.

Step 9Restart Server

Restart your Garry's Mod server. Once it boots back up, your infrastructure will be fully connected and data will begin streaming to your dashboard!

Stuck or need help? Join our Discord Community for support.