Getting Started

This guide walks you through everything you need to build and publish your first game on RUN.game — from installation to your first deploy.

1

Install Node.js

You'll need version 20 or higher.

Install Node.js

2

Install the RUN.game CLI

The RUN.game CLI is what you'll use to initialize, manage, and deploy your games.

MacOS / Linux

Open a Terminal and run:

curl -fsSL https://github.com/series-ai/rundot-cli-releases/releases/latest/download/install.sh | bash

Restart your Terminal after installation so it can find the CLI.

Windows

Open PowerShell and run:

irm https://github.com/series-ai/rundot-cli-releases/releases/latest/download/install.ps1 | iex

3

Verify installation

rundot --help

You should see a list of available commands. If not, see Troubleshooting.

4

Install the RUN.game SDK

From your project's root folder:

npm install @series-inc/rundot-game-sdk@latest

The SDK is updated frequently. To update it, simply re-run the command above.

5

Create your game project

You have two options: start from a template, or set up a project from scratch.

Option A: Start from a template

Templates make it easy to get started. Pick the one that fits your game:

2D game template (Phaser)

3D game template (React)

2D - UI-heavy React game template

Unzip the template, open it in your code editor, and install dependencies:

npm install

Option B: Build from scratch

If you're an experienced developer and prefer setting up projects manually:

1. Use relative file paths. When deployed, your game is served from a subdirectory. If you use Vite, add this to vite.config.js:

{
  base: './',
}

1. Build to ./dist. The CLI looks for your build there by default. You can customize the build path if needed.

6

Initialize your game

From your project's root folder:

rundot init

This walks you through naming and configuring your game for the RUN.game platform. It creates a game.config.json file that stores your game ID and build settings.

See Initializing Your Game for more details and manual options.

7

Deploy to RUN.game

Build and deploy your game:

npm run build
rundot deploy

You'll get a shareable link, playable by anyone on web or in the RUN.game app. The link is unlisted by default — no one will find it on the platform unless you publish it.

See Deploying Your Game for publishing, versioning, and advanced options.

Updating the CLI

The CLI will alert you when a new version is available. To update manually:

rundot update