docs.joinplayroom.com Open in urlscan Pro
76.76.21.123  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Playroom KitAbout Playroom ↗About Playroom ↗ (opens in a new tab)NPM ↗NPM ↗
(opens in a new tab)Feature Requests ↗Feature Requests ↗ (opens in a new tab)
CTRL K
CTRL K
 * ⛳️ | Introduction
 * 🕹️ | Making Multiplayer
    * Types of Games
    * Mobile Multiplayer
    * Stream Mode
    * Tv Mode

 * 🧩 | Setup
 * 🤖 | Multiplayer Modules
    * Lobby
    * Joystick
    * Gamepads
    * Bots new

 * 📙 | Usage
    * Usage with Three.js
    * Usage with React
    * Usage with Unity
    * Usage with PlayCanvas
    * Usage with Phaser
    * Usage with Kaboom
    * Usage with PixiJS new
    * Usage with Spline

 * 📺 | Tutorials
 * 🍱 | Templates
 * 🔖 | API Reference
    * Hooks for React
    * Unity (C#) API

 * 📊 | Comparing Playroom
 * 🧙🏻‍♀️ | Upcoming: Playroom AI
 * 🧾 | Billing FAQs
 * 📜 | Changelog

 * --------------------------------------------------------------------------------

 * 📝 | Blog
    * Multiplayer Edge Cases
    * October & November Update: Community-driven Success
    * Playroom partners with Axie Infinity
    * September Update: Tech Milestones, Developers and Games
    * Making Playroom's JavaScript Plugin for Unity
    * WebXR, Vision Pro, and Multiplayer
    * Streamers Drive Explosive Demand for Social Multiplayer Games
    * August Update: Launches, Learnings and Templates!
    * Making a multiplayer game is not simple
    * July Update: YouTuber joins Playroom and GameJam
    * June Update: Bunch partnership and Multiplayer Kit
    * May Update: SDK & AI Game Editor
    * April Update: GDC & Playroom AI Engine
    * March Update: Game making with AI
    * February Update: Multiplayer & AI Trivia
    * January Update: AssemblyAI Hack Winner & SDK

 * ⛳️ | Introduction
   * What is Playroom Kit?
   * Why Playroom Kit?
   * Great for Web Games
   * What's the API like?
 * 🕹️ | Making Multiplayer
    * Types of Games
    * Mobile Multiplayer
    * Stream Mode
    * Tv Mode

 * 🧩 | Setup
 * 🤖 | Multiplayer Modules
    * Lobby
    * Joystick
    * Gamepads
    * Bots new

 * 📙 | Usage
    * Usage with Three.js
    * Usage with React
    * Usage with Unity
    * Usage with PlayCanvas
    * Usage with Phaser
    * Usage with Kaboom
    * Usage with PixiJS new
    * Usage with Spline

 * 📺 | Tutorials
 * 🍱 | Templates
 * 🔖 | API Reference
    * Hooks for React
    * Unity (C#) API

 * 📊 | Comparing Playroom
 * 🧙🏻‍♀️ | Upcoming: Playroom AI
 * 🧾 | Billing FAQs
 * 📜 | Changelog

 * --------------------------------------------------------------------------------

 * 📝 | Blog
    * Multiplayer Edge Cases
    * October & November Update: Community-driven Success
    * Playroom partners with Axie Infinity
    * September Update: Tech Milestones, Developers and Games
    * Making Playroom's JavaScript Plugin for Unity
    * WebXR, Vision Pro, and Multiplayer
    * Streamers Drive Explosive Demand for Social Multiplayer Games
    * August Update: Launches, Learnings and Templates!
    * Making a multiplayer game is not simple
    * July Update: YouTuber joins Playroom and GameJam
    * June Update: Bunch partnership and Multiplayer Kit
    * May Update: SDK & AI Game Editor
    * April Update: GDC & Playroom AI Engine
    * March Update: Game making with AI
    * February Update: Multiplayer & AI Trivia
    * January Update: AssemblyAI Hack Winner & SDK

 * About Playroom ↗ (opens in a new tab)
 * NPM ↗ (opens in a new tab)
 * Feature Requests ↗ (opens in a new tab)



New Post: Multiplayer Edge Cases →


BUILD MULTIPLAYER
GAMES IN MINUTES


PLAYROOM KIT IS A HIGH-PERFORMANCE SYNC THAT HANDLES THE NETWORKING AND THE ROOM
MANAGEMENT SO YOU CAN FOCUS ON BUILDING YOUR GAME.

Making Multiplayer Game →



WHAT IS PLAYROOM KIT?

Playroom Kit simplifies the development of real-time web-based multiplayer games
by offering seamless synchronization and state management features. With its
convenient integration capabilities, you can effortlessly incorporate the kit
into popular game engines and libraries, transforming any game into a
multiplayer experience.

We believe that gaming is more enjoyable when shared with friends, whether they
are online, nearby, connected through Discord, part of a Twitch community, or
even gathered with family at home. With Playroom Kit, you have the flexibility
to create your game to suit any multiplayer scenario.


WHY PLAYROOM KIT?

REALTIME STATE SYNC

Realtime sync of game and player state between all players and screens.

LOW LATENCY

Automatically switch between WebRTC and WebSockets for <50ms latency.

NO BACKEND

Serverless architecture with no backend code to write or manage.

REGION: EARTH

Nearest websocket backend running within milliseconds of the players.

PLAYER MANAGEMENT

Automatically handle players, room creation and joining via URL or QR code.

BUILT-IN UI

Letting players pick their names, colors and avatars with embedded UI.

--------------------------------------------------------------------------------


GREAT FOR WEB GAMES

Use Playroom Kit to make web-based games. We officially support the following
engines:

Three.jsReactPhaserPlayCanvasUnityKaboomSplinePixiJS


WHAT'S THE API LIKE?

Playroom Kit provides a simple API to set or get the state of the game room. The
state is automatically synced between all players and screens.

import { getState, setState } from 'playroomkit'
 
// Set some game state, this will be synced to all players
setState({ timeRemaining: 60 });
// ...
 
// One some other device: Get the time remaining
const state = getState("timeRemaining");



Playroom also takes care of player and room management. You just need to call
insertCoin() somewhere in your game to show the lobby UI.

import { insertCoin } from 'playroomkit'
 
// Show the lobby UI
await insertCoin();
 
// Handle players joining the game
onPlayerJoin((player) => {
  console.log(`${player.getProfile().name} joined the game`);
});



See the API Reference for more details.


🕹️ | Making Multiplayer

--------------------------------------------------------------------------------

2023 © Playroom Inc.