Skip to content

Windows standalone ​

Use this route for a local test server or a Windows host without Docker. Examples use F:\Servers\OpenRP-Framework; replace that with your installation directory.

Prepare the game ​

  1. Install MariaDB, Node.js 22.12+ and sampctl.
  2. Download the Windows open.mp server from the official releases. Put its runtime beside the framework files without replacing your configured files.
  3. Install matching Windows components/plugins. Follow the plugin placement advice in the open.mp installation guide; an open.mp component is not loaded as a legacy plugin.
  4. Complete the database setup, copy the local configuration examples and compile.
  5. Put collision data at scriptfiles/colandreas/ColAndreas.cadb.

First foreground startup ​

From PowerShell:

powershell
Set-Location F:\Servers\OpenRP-Framework
.\omp-server.exe

Watch log.txt. The game should connect to MariaDB, initialise ColAndreas and load the seeded factions. A missing database or invalid collision database stops startup. Empty property and vehicle counts are normal.

Connect privately with your configured game port. Do not expose an unfinished map to players; place the required coordinates first.

Start the web application ​

Inside web-platform/web, copy .env.example to .env.local, fill in your own settings and run:

powershell
npm ci
npm run db:generate
npm run build
npm start

The standalone launcher binds to 127.0.0.1:3000 by default. For development use npm run dev instead. These are separate modes; stop the running production app before rebuilding its output on Windows.

Create the first administrator, sign in, and configure email. For public access, place the web app behind an HTTPS reverse proxy and use your real HTTPS AUTH_URL.

Add ACP process control ​

Set these in the agent’s .env:

dotenv
AGENT_BIND=127.0.0.1
AGENT_PORT=7001
SAMP_DIR=F:/Servers/OpenRP-Framework
SAMP_BIN=./omp-server.exe
SAMP_HOST=127.0.0.1
SAMP_PORT=7777
SAMP_AGENT_KEY=GENERATE_YOUR_OWN_RANDOM_KEY
SAMP_RCON_PASSWORD=

Use the same key in the web app. Run npm ci and npm start from web-platform/samp-agent. If the native PTY dependency needs compiling, install the Windows C++ build tools appropriate to your Node version.

Stop the foreground game before clicking ACP Start. The agent must create the process it controls. A game started in another terminal will not become an agent-owned process just because it uses the same folder.

Unattended operation ​

Supervise the web and agent processes using your Windows service tooling. Set each service’s working directory explicitly and run it under an account that can read the required secrets and write game logs/runtime files. Keep only one owner for the game process.

Allow the configured game UDP port through the firewall, and the artwork TCP port if downloads are used. Keep MariaDB and the agent private. See ports and server control.

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