rpgjs

Inspect, install, and implement features in RPGJS v5 game projects using live documentation.

1.7k|246|Updated Apr 10, 2011
One-click install
npx skills add https://github.com/RSamaium/RPG-JS --skill rpgjs-rsamaium
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rpgjs
Source: https://github.com/RSamaium/RPG-JS/tree/main/skills/rpgjs
Command: npx skills add https://github.com/RSamaium/RPG-JS --skill rpgjs-rsamaium

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Working on an RPGJS v5 game project requires up-to-date knowledge of its APIs, project structure, and companion libraries, and guessing from memory leads to incorrect code. This Skill verifies whether a codebase is an RPGJS project, bootstraps one from the official quick start when missing, and fetches live documentation before making changes. ## Core Features & Use Cases - Project Verification and Bootstrap: Detects @rpgjs/* packages in package.json and, when absent, installs the official scaffold with Tiled map integration and example maps. - Live Documentation Workflow: Fetches the RPGJS v5 llms.txt index, CanvasEngine docs for .ce files, the UI CSS README for GUI styling, the physic README for collisions, and the synchronization guide for networked state. - Architecture Guidance: Provides reference notes on entrypoints, map providers, server hooks, player props, variables, and event collision models. - Use Case: A developer asks to add a synchronized player inventory to an MMORPG map; the Skill confirms the project, fetches the synchronization guide, and implements state via player props instead of ad hoc storage. ## Quick Start Use the rpgjs skill to verify this workspace is an RPGJS v5 project and then implement a new map event following the official documentation.

Frequently Asked Questions about rpgjs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I verify a project is an RPGJS v5 project?

Search the project's package.json files for @rpgjs dependencies, for example with ripgrep. If no local package.json references @rpgjs packages, the workspace is not an RPGJS project and should be bootstrapped from the official quick start first.

How do I install a new RPGJS v5 project from scratch?

Fetch and read the official quick start at https://v5.rpgjs.dev/guide/quick-start.md, then follow its documented installation steps. The generated scaffold includes Tiled map editor integration and example maps, which should be kept as the baseline.

How does RPGJS synchronize player state between client and server?

RPGJS uses synchronized player props for durable gameplay state that must survive map transfers, snapshots, and restarts. Use map.broadcast for ephemeral map-wide messages and player.on for explicit client-sent socket data, keeping the three channels distinct.

What are .ce files in an RPGJS project?

Files ending in .ce are CanvasEngine components used for menus, HUDs, dialogs, and overlays. Before editing them, fetch the CanvasEngine documentation index at https://canvasengine.net/llms.txt and verify syntax against the fetched pages rather than memory.

When should I use player props versus variables in RPGJS?

Use player props for synchronized state that must persist across maps, snapshots, or restarts. Use the built-in variable system for game-state conditions that drive event visibility, progression, and save workflows, since RPGJS reacts automatically to variable changes.