Real-time State Sync with Socket.IO

This example demonstrates how to use @colyseus/schema with Socket.IO for efficient real-time state synchronization.

Features

• Easy to Use: Clean API similar to regular Socket.IO
• Efficient State Sync: Only sends what changed, not the entire state
• Type Safety: TypeScript support with schema decorators - catches errors at compile time
• Reactive Callbacks: Listen to specific property changes

Limitations

This example uses a single Encoder for all connections. You may extend it to support a multiple Encoder‘s per Socket.io Room. As @colyseus/schema is in-memory and single-threaded, it is not possible to scale the same Encoder between multiple servers or processes. If you're interested in scaling this approach, you can check how to scale Colyseus applications (without Socket.IO).

Quick Start

1. Install dependencies:

   npm install

2. Run the server:

   npm start

3. Start the client:

   npm run client

How It Works

Shared Schema Definition (src/GameState.ts)

• Defines Player and GameState classes with @colyseus/schema decorators
• Provides type safety and efficient serialization

Server (src/server.ts)

• Uses Encoder to track and send only state changes

Client (src/client.ts)

• Uses Decoder to apply state updates
• Reactive callbacks respond to specific changes

The result is a robust foundation for real-time multiplayer applications.

License

MIT