Skip to content

Branding and server settings ​

The game, community website and server agent have separate configuration surfaces. Keep their names, database and ports aligned; changing one does not automatically update the others.

Game configuration ​

Copy config.example.json to config.json before starting open.mp. Important fields include:

FieldPurpose
name, game.mode, game.map, websiteServer-browser identity
network.port, network.bind, max_playersGame listener and capacity
pawn.main_scriptsLoads gamemode 1
pawn.legacy_pluginsLegacy plugins; open.mp components use the components directory
pawn.side_scriptsEmpty by default; integrated admin flight/client checks need no filterscripts
logging.filelog.txt, the file read by the agent
artwork.*Model directory, artwork listener and optional CDN
rcon.*Remote console configuration, disabled by default
announcePublic server listing, off until you are ready

See the official config.json reference for engine fields. server.cfg is not the main configuration for the documented open.mp installation.

Compiled game identity ​

In gamemodes/config/header.pwn, set SERVER_NAME, SERVER_MODE, SERVER_MAP, SERVER_WEBSITE and SERVER_DISCORD. These affect game messages and related systems. Recompile after editing them.

Copy gamemodes/config/secrets.example.pwn to secrets.pwn. Replace SERVER_PASSWORD with your own value for the script’s server-side password/maintenance check. It is distinct from config.json’s RCON password and from player credentials.

Database and web settings ​

Copy mysql.example.ini to mysql.ini for the game. The web app uses DATABASE_URL in .env.local; point both at the same database. See environment examples.

In web-platform/web/lib/site-config.ts, replace the community name, links, logo, hero image, connect address and public policies. Keep optional links blank until configured. The OpenRP Framework project website is maintained separately from your community’s web template.

Apply changes deliberately ​

Changed itemApply it with
Pawn source/feature flagsRecompile and restart game
Engine config.jsonRestart game
Web source/public assetsRebuild and restart web
Web/agent environmentRestart the affected process
ACP armory/uniform dataRelevant in-game reload command
Custom model registrationFull game restart, not just a uniform reload

Keep configured files and secrets outside release archives. Ship only example configuration and instructions.

Open-source roleplay foundations for open.mp. Bring your own world.