Skip to content

First setup checklist ​

Follow this order for a new installation. Commands are run from the framework root unless a different directory is stated.

1. Prepare the runtime ​

  • [ ] Install Node.js, npm and sampctl.
  • [ ] Obtain open.mp and matching components/plugins for your OS.
  • [ ] Create a private MariaDB instance and an application database user.
  • [ ] Generate the ColAndreas collision file.

2. Configure and build the game ​

  • [ ] Copy mysql.example.ini to mysql.ini; use your application database credentials.
  • [ ] Copy config.example.json to config.json; configure the name, ports and runtime.
  • [ ] Copy gamemodes/config/secrets.example.pwn to gamemodes/config/secrets.pwn and replace its password placeholder.
  • [ ] Import the clean database.
  • [ ] Set branding and feature flags.
  • [ ] Run sampctl ensure, then sampctl build.

3. Bring up the web platform ​

  • [ ] Copy web-platform/web/.env.example to .env.local and complete the web environment.
  • [ ] Configure your own mail service, public origin and unique authentication secret.
  • [ ] Install web dependencies and generate Prisma.
  • [ ] Create the first administrator using the bootstrap command.
  • [ ] Build and start the website. Verify an email and create a character.

4. Connect the agent ​

  • [ ] Configure its .env, game directory and platform-specific binary.
  • [ ] Give the agent and web app the same generated agent key.
  • [ ] Stop any manually started game, start the agent, then start the game through ACP.
  • [ ] Test status, console permissions and graceful stop on a private server.

5. Build your world ​

  • [ ] Set all TODO: set coordinates for your map locations.
  • [ ] Place SAPD/FDSA spawns and lockers.
  • [ ] Configure uniforms, faction access and emergency vehicles.
  • [ ] Create properties, businesses, dealerships, job vehicles and delivery destinations.
  • [ ] Place the delivery depot in Blueberry if using the intended starter location.
  • [ ] Publish your community rules and policies in the web template.

6. Prove the installation ​

Walk through the production launch checklist. Include ordinary-player and lower-rank staff accounts in your test. A developer account can conceal a permission or onboarding problem that everyone else will encounter.

Existing server?

Do not import the fresh schema over live data. Follow the backup and update procedure and apply the additive web migration instead.

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