Welcome to NSM Documentation

Official documentation for the NSM multiplayer modification client (NSM.exe), dedicated server (nsm-server.exe), and the AFX Portal ecosystem.

NSM Client Manual

Install, launch, link your AFX account in-app, and connect to servers via the Server Browser or F8 console.

Server Manual

Configure nsm-server.exe, register a key in AFX Portal, and publish your server to the live masterlist.

Scripting Manual

Create Lua, JavaScript, and C# resources, NUI interfaces, and synchronized OneSync state bags.

Native Reference

Search client and server natives for entities, vehicles, events, NUI callbacks, and player identifiers.

NSM Client Manual & In-App Sign-In

Start the local NSM stack using START-LOCALHOST.ps1 (which starts NSM-Masterlist.exe on 127.0.0.1:80 and launches NSM.exe).

One-Click In-App Account Linking: When you click Sign In inside NSM.exe, your client communicates directly with http://127.0.0.1, decrypts your RSA User-API-Key, and loads your custom AFX profile and avatar automatically.

Setting Up an NSM Dedicated Server

1. Open AFX Portal (/keymaster) and generate a Server Registration Key (nsm_srv_...).
2. Add the key to your server-local.cfg or server.cfg:

endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"

sv_hostname "^5NSM Official ^0| ^2Roleplay & Freeroam"
sets sv_projectName "NSM Official Server"
sets sv_projectDesc "Custom Cars, MLOs, Active Staff & Economy"
sets tags "roleplay,economy,custom-cars,nsm"
sets locale "en-US"
sv_maxclients 48

# Authenticate with the NSM Masterlist via AFX Portal Keymaster
sets sv_nsmServerKey "nsm_srv_YOUR_KEY_HERE"

Creating a Resource (`fxmanifest.lua`)

fx_version 'cerulean'
game 'gta5'

author 'Cravenz'
description 'NSM Custom Gameplay Resource'
version '1.0.0'

client_scripts { 'client/main.lua' }
server_scripts { 'server/main.lua' }

Interactive Native Reference

Native / Function	Realm	Description
`RegisterCommand(commandName, handler, restricted)`	Shared	Registers a chat or F8 console command on client or server.
`TriggerClientEvent(eventName, playerId, ...)`	Server	Sends a network event from the server to one or all connected clients (`-1`).
`TriggerServerEvent(eventName, ...)`	Client	Sends a network event from the client to the NSM server.
`SendNUIMessage(dataTable)`	Client	Dispatches a JSON message to the resource's CEF NUI frame (received via `window.addEventListener('message')`).
`CreateVehicle(modelHash, x, y, z, heading, isNetwork, netMissionEntity)`	Shared	Spawns a networked or local vehicle at the specified world coordinates.
`SetEntityCoords(entity, x, y, z, xAxis, yAxis, zAxis, clearArea)`	Shared	Sets the world coordinates of a ped, vehicle, or object entity.