create-roomkit

Scaffolding tool for creating new RoomKit multiplayer projects.

Usage

Create a new RoomKit project with:

``bash
npm create roomkit@latest
`

Or with npm 7+:

`bash
npm create roomkit@latest my-game
`

Or with pnpm:

`bash
pnpm create roomkit my-game
`

Or with yarn:

`bash
yarn create roomkit my-game
`

Templates

Choose from three templates:

$3

A minimal gateway + worker setup with a simple room.
Perfect for learning or starting a custom project.

$3

A fully-featured real-time chat application with:
- User presence
- Typing indicators
- Chat history
- Username customization

$3

A turn-based Tic-Tac-Toe game demonstrating:
- Turn-based gameplay
- Win/draw detection
- Game state management
- Player disconnect handling

Options

`bash


Specify project name

npm create roomkit@latest my-project

Specify template

npm create roomkit@latest my-project -- --template chat-room

Available templates: basic, chat-room, game-room

`

After Creation

`bash
cd my-project
npm install
npm run dev
`

Make sure you have Redis running locally, or configure it in the .env file.

Requirements

- Node.js 18+
- Redis server

Project Structure

All templates include:

`
my-project/
├── src/
│ ├── gateway.ts # Gateway server
│ ├── worker.ts # Worker server
│ └── rooms/ # Your game rooms
├── package.json
├── tsconfig.json
├── .env.example
└── README.md
``

Learn More

- RoomKit Documentation
- Gateway API
- Worker API
- Client SDK

License

MIT