# RPGJS

## Docs

- [Latency Simulation](https://v5.rpgjs.dev/advanced/latency-simulation.md): Guide for Latency Simulation in RPGJS.
- [MMORPG entries](https://v5.rpgjs.dev/advanced/mmorpg-entries.md): Organize client, server, and adapter entry points for an MMORPG project, with an Express example.
- [Node server in production](https://v5.rpgjs.dev/advanced/node-server-production.md): Run RPGJS without Vite in production, secure map updates, and mount the transport in a Node HTTP server.
- [Packet Loss Simulation](https://v5.rpgjs.dev/advanced/packet-loss-simulation.md): Guide for Packet Loss Simulation in RPGJS.
- [provideLoadMap](https://v5.rpgjs.dev/advanced/provide-load-map.md): Guide for provideLoadMap in RPGJS.
- [API overview](https://v5.rpgjs.dev/api.md): Overview of the RPGJS API reference for player, map, client, and hooks.
- [Client API](https://v5.rpgjs.dev/api/client/index.md): Reference for the client engine and client-side runtime helpers.
- [Rpg Client Engine](https://v5.rpgjs.dev/api/client/rpg-client-engine.md): Reference for the `RpgClientEngine` class.
- [Event hooks](https://v5.rpgjs.dev/api/map/hooks.md): Hooks for events created as plain objects, as shown in the create-event guide.
- [Map API](https://v5.rpgjs.dev/api/map/index.md): Reference for RpgMap, world map helpers, controls, and event hooks used by created events.
- [Map Types](https://v5.rpgjs.dev/api/map/map-types.md): Supporting interfaces related to map controls.
- [RpgMap](https://v5.rpgjs.dev/api/map/rpg-map.md): Reference for the `RpgMap` class.
- [World Maps](https://v5.rpgjs.dev/api/map/world-maps.md): Reference for world map helpers.
- [Battle Commands](https://v5.rpgjs.dev/api/player/battle-commands.md): Battle formulas and server-side battle helpers for players.
- [Class Commands](https://v5.rpgjs.dev/api/player/class-commands.md): Assign and inspect player classes and class-driven behaviors.
- [Common Commands](https://v5.rpgjs.dev/api/player/common-commands.md): Core server-side player commands defined on the main Player class.
- [Components](https://v5.rpgjs.dev/api/player/components.md): Component-based UI layout helpers and component utilities for players.
- [Effect Commands](https://v5.rpgjs.dev/api/player/effect-commands.md): Apply and inspect player effects.
- [Element Commands](https://v5.rpgjs.dev/api/player/element-commands.md): Element offense, defense, and coefficient helpers for players.
- [Gold Commands](https://v5.rpgjs.dev/api/player/gold-commands.md): Read and update player gold on the server side.
- [GUI Commands](https://v5.rpgjs.dev/api/player/gui-commands.md): Dialogs, menus, notifications, and custom GUI commands.
- [Player API](https://v5.rpgjs.dev/api/player/index.md): Server-side Player API reference for RpgPlayer and its managers.
- [Item Commands](https://v5.rpgjs.dev/api/player/item-commands.md): Inventory, equipment, and item usage commands for players.
- [Move Commands](https://v5.rpgjs.dev/api/player/move-commands.md): Movement APIs, movement strategies, and move route helpers.
- [Parameter Commands](https://v5.rpgjs.dev/api/player/parameter-commands.md): Level, experience, HP, SP, and parameter management for players.
- [Skill Commands](https://v5.rpgjs.dev/api/player/skill-commands.md): Learn, forget, and use skills from the server-side player API.
- [State Commands](https://v5.rpgjs.dev/api/player/state-commands.md): Apply, remove, and inspect player states.
- [Variable Commands](https://v5.rpgjs.dev/api/player/variable-commands.md): Store and retrieve player variables that persist across saves and map transfers.
- [Dialog Box](https://v5.rpgjs.dev/gui/dialog-box.md): Guide for Dialog Box in RPGJS.
- [Engine Injection in .ce Files](https://v5.rpgjs.dev/gui/engine-injection.md): Guide for Engine Injection in .ce Files in RPGJS.
- [HUD](https://v5.rpgjs.dev/gui/hud.md): Guide for HUD in RPGJS.
- [Optimistic GUI Actions](https://v5.rpgjs.dev/gui/optimistic-actions.md): Guide for Optimistic GUI Actions in RPGJS.
- [Title Screen](https://v5.rpgjs.dev/gui/title-screen.md): Guide for Title Screen in RPGJS.
- [Vue.js 3 Integration with RPGJS GUI System](https://v5.rpgjs.dev/gui/vue-integration.md): Guide for Vue.js 3 Integration with RPGJS GUI System in RPGJS.
- [Action Battle System](https://v5.rpgjs.dev/guide/battle-ai.md): Use the real-time action battle AI system for RPGJS enemies.
- [Create database](https://v5.rpgjs.dev/guide/create-database.md): Register items, skills, states, and other game data.
- [Create an event](https://v5.rpgjs.dev/guide/create-event.md): Create your first NPC or interactive event.
- [Create hero in map](https://v5.rpgjs.dev/guide/create-hero-in-map.md): Spawn the player in a map and assign the first hero graphic.
- [Creating Modules in RPGJS](https://v5.rpgjs.dev/guide/create-module.md): Guide for Creating Modules in RPGJS in RPGJS.
- [Movement System Guide](https://v5.rpgjs.dev/guide/create-movement.md): Guide for Movement System Guide in RPGJS.
- [Create Shape](https://v5.rpgjs.dev/guide/create-shape.md): Guide for Create Shape in RPGJS.
- [Create sounds](https://v5.rpgjs.dev/guide/create-sounds.md): Register sounds on the client and play them from gameplay code.
- [Create spritesheet](https://v5.rpgjs.dev/guide/create-spritesheet.md): Register your first character spritesheet in RPGJS.
- [Create a world](https://v5.rpgjs.dev/guide/create-world.md): Connect several maps together inside a world.
- [Create your first map](https://v5.rpgjs.dev/guide/create-your-first-map.md): Add your first playable map to an RPGJS project.
- [Display Animations](https://v5.rpgjs.dev/guide/display-animations.md): Guide for Display Animations in RPGJS.
- [Event Modes: Shared vs Scenario](https://v5.rpgjs.dev/guide/event-modes.md): Guide for Event Modes: Shared vs Scenario in RPGJS.
- [Getting Started](https://v5.rpgjs.dev/guide/get-started.md): Understand what RPGJS gives you before building your first game.
- [Attach GUI to Sprites Guide](https://v5.rpgjs.dev/guide/gui/attach-gui.md): Guide for Attach GUI to Sprites Guide in RPGJS.
- [Items System](https://v5.rpgjs.dev/guide/items.md): Guide for Items System in RPGJS.
- [Move Routes](https://v5.rpgjs.dev/guide/move-routes.md): Guide for Move Routes in RPGJS.
- [Prebuilt Components](https://v5.rpgjs.dev/guide/prebuilt-components/index.md): Guide for Prebuilt Components in RPGJS.
- [Light Halo Component](https://v5.rpgjs.dev/guide/prebuilt-components/light-halo.md): Guide for Light Halo Component in RPGJS.
- [Quick Start](https://v5.rpgjs.dev/guide/quick-start.md): Create and run your first RPGJS project in a few minutes.
- [Save/Load Strategy (Client-Driven)](https://v5.rpgjs.dev/guide/save-load.md): Guide for Save/Load Strategy (Client-Driven) in RPGJS.
- [Sounds Guide](https://v5.rpgjs.dev/guide/sounds.md): Guide for Sounds Guide in RPGJS.
- [Sprite Components Guide](https://v5.rpgjs.dev/guide/sprite-components.md): Guide for Sprite Components Guide in RPGJS.
- [Spritesheets Guide](https://v5.rpgjs.dev/guide/spritesheets.md): Guide for Spritesheets Guide in RPGJS.
- [Structure](https://v5.rpgjs.dev/guide/structure.md): Understand the default RPGJS project structure.
- [Synchronization between Server and Client](https://v5.rpgjs.dev/guide/synchronization.md): Guide for Synchronization between Server and Client in RPGJS.
- [Testing with @rpgjs/testing](https://v5.rpgjs.dev/guide/testing.md): Guide for Testing with @rpgjs/testing in RPGJS.
- [Weather](https://v5.rpgjs.dev/guide/weather.md): Guide for Weather in RPGJS.
- [Client Engine Hooks](https://v5.rpgjs.dev/hooks/client-engine-hooks.md): Guide for Client Engine Hooks in RPGJS.
- [Client Physics Hooks](https://v5.rpgjs.dev/hooks/client-physics-hooks.md): Guide for Client Physics Hooks in RPGJS.
- [Client Scene Hooks](https://v5.rpgjs.dev/hooks/client-scene-hooks.md): Guide for Client Scene Hooks in RPGJS.
- [Client Sprite Hooks](https://v5.rpgjs.dev/hooks/client-sprite-hooks.md): Guide for Client Sprite Hooks in RPGJS.
- [Server Engine Hooks](https://v5.rpgjs.dev/hooks/server-engine-hooks.md): Guide for Server Engine Hooks in RPGJS.
- [Server Event Hooks](https://v5.rpgjs.dev/hooks/server-event-hooks.md): Guide for Server Event Hooks in RPGJS.
- [Server Map Hooks](https://v5.rpgjs.dev/hooks/server-map-hooks.md): Guide for Server Map Hooks in RPGJS.
- [Server Player Hooks](https://v5.rpgjs.dev/hooks/server-player-hooks.md): Guide for Server Player Hooks in RPGJS.
- [Introduction](https://v5.rpgjs.dev/index.md): Welcome to the new home for your documentation
- [Use a game with Studio](https://v5.rpgjs.dev/studio/game-integration.md): Connect an RPGJS game to RPGJS Studio data with provideStudioGame.
- [Studio overview](https://v5.rpgjs.dev/studio/index.md): Use RPGJS Studio with AI assistants such as Claude Code, Codex, or similar tools.
- [Using TiledMap with RPG-JS](https://v5.rpgjs.dev/tiled/index.md): Guide for Using TiledMap with RPG-JS in RPGJS.

## OpenAPI Specs

- [openapi](https://v5.rpgjs.dev/api-reference/openapi.json)