Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grayhatdevelopers/create-multiplayer-game
Create a multiplayer web game in seconds 👾🚀
https://github.com/grayhatdevelopers/create-multiplayer-game
game game-development gaming javascript multiplayer multiplayer-game nodejs playroom playroom-kit playroomkit web web-game
Last synced: 5 days ago
JSON representation
Create a multiplayer web game in seconds 👾🚀
- Host: GitHub
- URL: https://github.com/grayhatdevelopers/create-multiplayer-game
- Owner: grayhatdevelopers
- License: cc0-1.0
- Created: 2024-01-21T18:10:55.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-22T09:57:03.000Z (6 months ago)
- Last Synced: 2024-05-22T11:32:01.677Z (6 months ago)
- Topics: game, game-development, gaming, javascript, multiplayer, multiplayer-game, nodejs, playroom, playroom-kit, playroomkit, web, web-game
- Language: JavaScript
- Homepage: https://grayhat.studio/games/pricing
- Size: 123 KB
- Stars: 9
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-multiplayer-game 
> ℹ️ This is a work-in-progress. Star (⭐) this repo to follow updates.
The web game framework which gets out of your way, and gives you control. Build games in days, not weeks!
## Use cases
- You can use it as a base for a fresh project
- As a wrapper for an existing game (e.g. to add start/end screens, to make your game a PWA)
- To quickly test out some logic in a multiplayer scenario
## Scaffolding Your First Web Game Project
> **Compatibility Note:**
> create-multiplayer-game requires [Node.js](https://nodejs.org/en/) version 21+.
With NPM:
```bash
npx create-multiplayer-game@latest
```
Then follow the prompts!
You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Vite + React project, you can run:
```bash
npx create-multiplayer-game@latest my-awesome-game --template vite-react-ts
```
Currently supported template presets include:
- `vite-react-ts`
- `next-ts`
- `vite-react-ts-premium` (coming soon)
- Some community-driven templates
You can use `.` for the project name to scaffold in the current directory.
## Syncing your template
You'll want to periodically pull updates from your base template. This ensures you're always packed with the latest features, bug fixes and more. This may cause merge conflicts.
To pull the latest from the template, simply run the following command in the **project directory**:
```bash
npx create-multiplayer-game sync
```
## Community Templates
create-multiplayer-game is a tool to quickly start a multiplayer web game project from a basic template for popular frameworks. Check out Awesome Playroom for [community maintained templates](https://github.com/grayhatdevelopers/awesome-playroom?tab=readme-ov-file#open-source-games-and-boilerplates) that include other tools or target different frameworks. You can use a tool like [degit](https://github.com/Rich-Harris/degit) to scaffold your project with one of the templates.
```bash
npx degit user/project my-project
cd my-project
npm install
npm run dev
```
If the project uses `main` as the default branch, suffix the project repo with `#main`
```bash
npx degit user/project#main my-project
```
### Want to add a template?
Feel free to add a template of your choice to create-multiplayer-game.
1. Edit this file: https://github.com/grayhatdevelopers/create-multiplayer-game/blob/main/src/utils/data/templates.mjs
2. Make a Pull Request.
It'll be reviewed and tested by the maintainers before merging.