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.

​
Use a game with Studio

Use provideStudioGame when the current RPGJS game should load its maps, database, media references, and player start configuration from RPGJS Studio data.

​
Install the package

npm install @rpgjs/studio

​
Studio mode

In Studio mode, the game reads data from RPGJS Studio. Add provideStudioGame to both the client and server configurations and pass the Studio project identifier. Client configuration: 
// src/config/config.client.ts
import { provideStudioGame } from "@rpgjs/studio/client";

export const configClient = {
  providers: [
    provideStudioGame({
      projectId: "your-project-id",
    }),
  ],
};
Server configuration: 
// src/config/config.server.ts
import { provideStudioGame } from "@rpgjs/studio/server";

export const configServer = {
  providers: [
    provideStudioGame({
      projectId: "your-project-id",
    }),
  ],
};
When projectId is set, the runtime uses online Studio data by default.

​
Offline mode

Offline mode lets the game run from exported Studio data without calling the Studio API. Export the project data from Studio into the game public directory, using the default bundle path: 
public/
  game-data/
    project.json
    database.json
    events.json
    maps/
      <map-id>.json
    media/
      media-index.json
Then configure provideStudioGame without projectId, or force runtimeMode to "offline": 
provideStudioGame({
  runtimeMode: "offline",
});
By default, offline data is loaded from /game-data. Use bundleBasePath only if the exported folder is served from another path: 
provideStudioGame({
  runtimeMode: "offline",
  bundleBasePath: "/my-game-data",
});

​
Auto mode

Use "auto" when the game should try the exported bundle first, then fall back to Studio if local data is missing: 
provideStudioGame({
  projectId: "your-project-id",
  runtimeMode: "auto",
});

​
Options

  • projectId: Studio project identifier. When provided, the default runtime mode is "online".
  • runtimeMode: data loading strategy. Use "online", "offline", or "auto".
  • bundleBasePath: public path for exported Studio data. Defaults to /game-data.
  • displayTitleScreen: display the Studio title screen when supported by the project.
  • startMapId: force the map used to start the player.