Skip to content

Quick Start

This guide shows the shortest path from an extracted server runtime archive to a running local server with one JavaScript resource.

Requirements

  • Windows 10/11 x64
  • Node.js for JavaScript resources — the working server runtime
  • .NET SDK — only for the preview C# SDK (the server binary does not execute C# resources yet)
  • Go toolchain — only for the preview Go SDK (the server binary does not execute Go resources yet)
  • A licensed GTA V client machine for connecting to the server

Install Runtime

Extract Varion-Server-Developer-MVP.zip (built by tools/package-developer-server.ps1) to a clean directory:

text
C:\Servers\my-server

The directory should contain:

text
varion-server.exe
server.toml
start-varion-server.ps1
build-info.json
README.md
host/varion-host.cjs
resources/
developer/

Run the server:

powershell
cd C:\Servers\my-server
.\varion-server.exe

Create The First Resource

Create this structure:

text
resources/
  mymode/
    resource.toml
    server/
      main.js

resources/mymode/resource.toml:

toml
enabled = true
type = "js"
main = "server/main.js"
client-type = "none"

resources/mymode/server/main.js:

javascript
varion.log('mymode started');

varion.on('playerConnect', (player) => {
  varion.log(`player connected: ${player.name}`);
});

Register it in server.toml. The JavaScript host starts automatically for a type = "js" resource — modules = ["js-module"] is not required:

toml
resources = [ "mymode" ]
modules = []

Start the server again:

powershell
.\varion-server.exe

Connect Client

Use the launcher/dev client flow to connect to:

text
127.0.0.1:7788

The default HTTP endpoint is:

text
http://127.0.0.1:7789/server-info.json

Next Reading

Varion Multiplayer Platform