Skip to content

Install the server ​

The VIMP updater downloads a matching server binary, embedded Node.js library, and native scripting binding. You do not need to build the Rust server.

Windows ​

Create an empty directory, download vimp-updater.exe, and install the server target:

powershell
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\vimp-server"
Set-Location "$env:USERPROFILE\vimp-server"
Invoke-WebRequest `
  -Uri "https://cdn.vi-mp.org/download/vimp-updater-windows/vimp-updater.exe" `
  -OutFile "vimp-updater.exe"
.\vimp-updater.exe --project vimp-server-windows

Linux ​

bash
mkdir -p "$HOME/vimp-server"
cd "$HOME/vimp-server"
curl -L "https://cdn.vi-mp.org/download/vimp-updater-linux/vimp-updater" \
  -o vimp-updater
chmod +x vimp-updater
./vimp-updater --project vimp-server-linux

Update channel ​

Stable is the default channel. Add --channel dev to either updater command to install the latest Dev server build. The choice is saved in update-channel.json in that installation directory, so later updates use the same channel. Use --channel stable to switch back. Keep Stable and Dev in separate directories if you want both installed at once. In the desktop client, the channel can also be changed in launcher Settings.

First start ​

Create scripting/server/main.js before launching the binary. The server writes a default config.json beside itself when that file does not exist.

js
vimp.markReady()

Run vimp-server.exe on Windows or ./vimp-server on Linux. The default bind address is local-only (127.0.0.1) and the default port is 7777. For remote players, set host to an appropriate interface and allow both TCP and UDP on the configured port.

Do not expose DevTools by accident

DevTools are disabled by default. Keep them disabled in production unless the allowlist is intentionally configured.

VIMP developer documentation