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.

Getting Started

RPGJS is a TypeScript framework for building browser RPGs and MMORPGs with the same core architecture. The default stack is:
  • TypeScript for game code
  • Vite for dev and build
  • CanvasEngine for rendering
  • RPGJS server and client packages for gameplay and networking

RPG or MMORPG

With the same project structure, you can run:
  • a standalone RPG with provideRpg(startServer)
  • an MMORPG with provideMmorpg()
That is why the starter contains both client.ts and standalone.ts.

Browser support

The client targets modern browsers such as Chrome, Firefox, Edge, and Brave. Internet Explorer is not supported.