Quick start¶
- Subscribe to Background NPCs on Steam Workshop, or put this repository in
garrysmod/addons/background-citizens. Avoid installing two copies. - Start a map, for example
gm_construct. Version 2.0 does not require SLibrary. - Open the developer console and run
bgn_menu. You can also use the Background NPCs icon in the C menu. - On first launch follow the setup wizard. Its body step chooses engine NPCs with FSM like the old versions (NPC replacers and mods for standard NPCs keep working) or NextBots with GOAP and the ghost crowd. You can change everything later in the settings.
- Walk around and allow time for spawning. Actors generally appear outside your view; the limit is not an immediate spawn command.
Server settings require admin rights. Voice and interface choices are local to each player.
Reopen setup¶
bgn_wizard
bgn_wizard all includes advanced steps. Changes in the wizard apply immediately; closing it does not undo them.
Back to the old behavior¶
An admin can force the old-version setup (NPC body, FSM brain, no ghost crowd, no scenic NPCs) at any time:
bgn_classic
!bgn_classic
The first is a console command, the second is typed in chat (!bgnclassic and the / prefix work too). Admins only. The server part applies to the server, the client part only to the caller; NPCs already on the map keep their body, reload the map for a clean start. Admins also get this tip in chat when they join.
Vehicles are optional¶
Install Decent Vehicle, vehicle models referenced by your actor configuration, and suitable DV waypoints for the map. Pedestrian routes and DV waypoints are separate.
Check navigation¶
Run bgn_nav_info in the server console (or as an admin). The addon can use custom routes, a NavMesh or an HL2 nodegraph. See navigation before generating new routes; engine nav_generate is not required by the addon.