colyseus
⚔ Multiplayer Framework for Node.js
File Explorer
Download Latest Version (.zip)- 01-report-a-bug.yml
- 02-feature-request.yml
- config.yml
- ci.yml
- publish_and_release.yml
- stale.yml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- FUNDING.yml
- launch.json
- index.ts
- vite.ts
- RoomBroadcast.ts
- RedisDriver.test.ts
- RedisPresence.test.ts
- LobbyRoom.test.ts
- LobbyRoomIntegration.test.ts
- QueueRoom.test.ts
- HTTP.test.ts
- uWebSockets.test.ts
- uWebSocketsBodyTimeout.test.ts
- index.ts
- Auth.test.ts
- createRoom.test.ts
- DevMode.test.ts
- Driver.test.ts
- ExceptionHandling.test.ts
- FullStackTypes.test.ts
- GracefulShutdown.test.ts
- Integration.test.ts
- IPC.test.ts
- MatchMaker.test.ts
- MetadataAPI.test.ts
- Presence.test.ts
- Room.test.ts
- RoomIntegration.test.ts
- RoomReconnection.test.ts
- Router.test.ts
- Server.test.ts
- Stats.test.ts
- tsconfig.json
- tslint.json
- CHANGELOG.md
- package.json
- header.png
- logo-cloud.svg
- logo.svg
- address-confirmation-email.html
- address-confirmation.html
- reset-password-email.html
- reset-password-form.html
- auth.ts
- Hash.ts
- index.ts
- JWT.ts
- oauth.ts
- Auth.test.ts
- Authentication.test.ts
- Middleware.test.ts
- CHANGELOG.md
- oauth_help_urls.json
- package.json
- RoomExceptions.ts
- SeatReservationError.ts
- ServerError.ts
- LocalDriver.ts
- Query.ts
- controller.ts
- driver.ts
- Lobby.ts
- RegisteredHandler.ts
- LocalPresence.ts
- Presence.ts
- LobbyRoom.ts
- QueueRoom.ts
- RelayRoom.ts
- default_routes.ts
- index.ts
- node.ts
- NoneSerializer.ts
- SchemaSerializer.ts
- Serializer.ts
- DevMode.ts
- Env.ts
- nanoevents.ts
- StandardSchema.ts
- Utils.ts
- Debug.ts
- index.ts
- IPC.ts
- Logger.ts
- MatchMaker.ts
- Protocol.ts
- Room.ts
- Server.ts
- Stats.ts
- Transport.ts
- strict-declarations.test-d.ts
- tsconfig.json
- CHANGELOG.md
- package.json
- vitest.config.ts
- index.ts
- PostgresDriver.ts
- utils.ts
- package.json
- index.ts
- package.json
- index.ts
- Query.ts
- RedisDriver.ts
- RoomData.ts
- CHANGELOG.md
- package.json
- vite.ts
- app.config.ts
- client.ts
- defineServer.ts
- MyRoom.ts
- sdk_fullstack_types.ts
- ServerExpress.ts
- ServerH3.ts
- ServerRaw.ts
- ServerTCP.ts
- ecosystem.config.cjs
- index.html
- package.json
- tsconfig.json
- vite.config.ts
- index.ts
- package-lock.json
- package.json
- bot.mjs
- bot.ts
- index.ts
- .editorconfig
- .gitignore
- bin.cjs
- package.json
- README.md
- screenshot.png
- tsconfig.json
- CAppBar.tsx
- RoomInspect.tsx
- RoomList.tsx
- index.css
- helpers.ts
- index.ts
- App.tsx
- index.tsx
- services.ts
- Room.ts
- api.ts
- index.ts
- .gitignore
- .npmignore
- build.mjs
- CHANGELOG.md
- index.html
- package.json
- tsconfig.backend.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- release-and-publish.yml
- favicon.ico
- index.html
- logo192.png
- logo512.png
- manifest.json
- robots.txt
- AuthOptions.tsx
- AuthTokenSection.tsx
- Callout.tsx
- ConnectionList.tsx
- DarkModeToggle.tsx
- InspectConnection.tsx
- JoinRoomForm.tsx
- JSONSchemaFields.tsx
- ResizableSidebar.tsx
- SDKCodeExamples.tsx
- StateView.tsx
- SettingsContext.tsx
- JSONEditor.css
- JSONEditor.tsx
- RoomWithId.tsx
- Timestamp.tsx
- APIEndpoints.tsx
- Home.tsx
- Playground.tsx
- PresenceInspector.tsx
- RealtimeRooms.tsx
- RealtimeStats.tsx
- ColyseusSDKExt.ts
- LimitedArray.ts
- Types.ts
- App.css
- App.tsx
- favicon.svg
- index.css
- index.tsx
- reportWebVitals.ts
- vite-env.d.ts
- colyseus.ext.ts
- index.ts
- .gitignore
- build.mjs
- CHANGELOG.md
- index.html
- package.json
- postcss.config.js
- tailwind.config.js
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- vitest.config.ts
- index.ts
- CHANGELOG.md
- package.json
- colyseus.d.ts.meta
- colyseus.js.meta
- browser.js
- package.json
- index.html
- main.ts
- tsconfig.json
- vite.config.ts
- browserstack-logo.png
- discord.ts
- http_bkp.ts
- nanoevents.ts
- signal.ts
- utils.ts
- Errors.ts
- FossilDeltaSerializer.ts
- NoneSerializer.ts
- SchemaSerializer.ts
- Serializer.ts
- H3Transport.ts
- ITransport.ts
- WebSocketTransport.ts
- Auth.ts
- Client.ts
- Connection.ts
- debug.ts
- fetchXHR.ts
- HTTP.ts
- index.ts
- legacy.ts
- Room.ts
- Storage.ts
- patch.ts
- auth.test.ts
- client.test.ts
- dist-types-check.ts
- h3transport.test.ts
- http.test.ts
- room.test.ts
- storage.test.ts
- util.ts
- tsconfig.all.json
- tsconfig.cjs.json
- tsconfig.esm.json
- cocos-creator.d.ts
- .editorconfig
- .gitignore
- .npmignore
- CHANGELOG.md
- dts-generator.json
- package.json
- rollup.config.mjs
- tsconfig.json
- tslint.json
- index.ts
- package.json
- index.ts
- package.json
- index.ts
- Protocol.ts
- types.test.ts
- package.json
- tsconfig.json
- vitest.config.ts
- index.ts
- Room.ext.ts
- TestServer.ts
- app.config.ts
- RoomWithoutState.ts
- RoomWithSimulation.ts
- RoomWithState.ts
- app.config.ts
- Bug939.test.ts
- Bug939Room.ts
- Usage.test.ts
- package.json
- app.ts
- colyseus.config.ts
- index.html
- ActionMethods.js
- post-deploy-agent.cjs
- shared.cjs
- index.ts
- loadenv.ts
- .colyseus-ecosystem.json
- dummy-server.cjs
- ecosystem.config.cjs
- max-memory-restart.test.ts
- pm2-deployment.test.ts
- CHANGELOG.md
- package.json
- post-deploy.cjs
- report-stats.cjs
- system-boot.cjs
- index.ts
- traefik.test.ts
- CHANGELOG.md
- package.json
- README.md
- traefik-http-provider.yml
- traefik-manual-hardcoded.yml
- traefik-redis-provider.yml
- BunWebSockets.ts
- index.ts
- WebSocketClient.ts
- Bun.test.ts
- CHANGELOG.md
- package.json
- tsconfig.json
- mkcert.ts
- H3Client.ts
- H3Transport.ts
- index.ts
- CHANGELOG.md
- package.json
- index.ts
- package.json
- index.ts
- uWebSocketClient.ts
- uWebSocketsTransport.ts
- CHANGELOG.md
- package.json
- index.ts
- WebSocketClient.ts
- WebSocketTransport.ts
- CHANGELOG.md
- package.json
- README.md
- better-call
- tsconfig.all.json
- tsconfig.test.json
- .all-contributorsrc
- .editorconfig
- .gitignore
- .gitmodules
- AGENTS.md
- BACKERS.md
- build.ts
- CHANGELOG_0.17.md
- jest.config.js
- LICENSE
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- tsconfig.json
- tslint.json
# Installation Guide
1. Get the code
git clone https://github.com/colyseus/colyseus
Downloads the entire project code from GitHub to your computer.
cd colyseus
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm create colyseus-app@latest ./my-server
Type this command into your terminal and run it.
npm start
Starts the development/run server.
<img src="https://img.shields.io/npm/dm/colyseus.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QAAKqNIzIAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAHdElNRQfjAgETESWYxR33AAAAtElEQVQoz4WQMQrCQBRE38Z0QoTcwF4Qg1h4BO0sxGOk80iCtViksrIQRRBTewWxMI1mbELYjYu+4rPMDPtn12ChMT3gavb4US5Jym0tcBIta3oDHv4Gwmr7nC4QAxBrCdzM2q6XqUnm9m9r59h7Rc0n2pFv24k4ttGMUXW+sGELTJjSr7QDKuqLS6UKFChVWWuFkZw9Z2AAvAirKT+JTlppIRnd6XgaP4goefI2Shj++OnjB3tBmHYK8z9zAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDE5LTAyLTAxVDE4OjE3OjM3KzAxOjAwGQQixQAAACV0RVh0ZGF0ZTptb2RpZnkAMjAxOS0wMi0wMVQxODoxNzozNyswMTowMGhZmnkAAAAZdEVYdFNvZnR3YXJlAHd3dy5pbmtzY2FwZS5vcmeb7jwaAAAAAElFTkSuQmCC">
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)