Skip to main content

Documentation Index

Fetch the complete documentation index at: https://v5.rpgjs.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Quick Start

Use the starter, install dependencies, and launch the dev server: 
npx degit rpgjs/starter#v5 my-rpg-game
cd my-rpg-game
npm install
npm run dev
Open http://localhost:5173.

​
Choose MMORPG or standalone RPG

By default, the starter runs in MMORPG mode. For standalone RPG mode, start the dev server with RPG_TYPE=rpg: 
RPG_TYPE=rpg npm run dev
On Windows, use cross-env: 
npm install --save-dev cross-env
npx cross-env RPG_TYPE=rpg npm run dev
Follow this order:
  1. Getting Started
  2. Structure
  3. Create your first map
  4. Create hero in map