Skip to content

Getting Started

The shortest useful path is to run the server, create one server script, and connect a VIMP client. Add TypeScript and client/UI code after that loop works.

What you need

  • A supported Windows or Linux machine for vimp-server.
  • A VIMP client and a GTA V installation for in-game testing.
  • Node.js 18 or newer for the TypeScript build toolchain. The game server ships its own Node.js runtime, so Node is not required on production hosts unless your deployment process uses it.
  1. Install the server.
  2. Create the first gamemode.
  3. Adopt the standard project structure.
  4. Enable TypeScript and VIMP declarations.
  5. Read the runtime lifecycle before adding asynchronous startup work.

Keep the first loop small

Start with playerConnected, a teleport, and vimp.markReady(). Add databases, CEF, and streamed assets one subsystem at a time after connection succeeds.

VIMP developer documentation