@colyseus/greeting-banner

中文文档
4.0.3发布于 2026/09/23MITTypeScriptESM + CJS零依赖近 30 天下载 61.9万

Greeting banner for Colyseus & Cloud

原始使用文档
文档目录3 节
  1. Multiplayer Framework for Node.js. View documentation
  2. Client SDKs
  3. Why developers choose Colyseus:


Discussion forum

Multiplayer Framework for Node.js.
View documentation

Colyseus is an Authoritative Multiplayer Framework for Node.js, with SDKs available for all major platforms and engines.

Client SDKs

PlatformInstallDocumentationDemo
TypeScriptnpm install @colyseus/sdkGetting StartedPlayCanvas
Reactnpm install @colyseus/reactGetting StartedR3F Lobby
UnityDownloadGetting StartedTank Battle
GodotDownloadGetting StartedTank Battle
GameMakerDownloadGetting StartedTank Battle
DefoldSee documentation →Getting StartedTank Battle
ConstructDownloadGetting StartedRaw Demo
Haxehaxelib install colyseusGetting StartedTank Battle
C / Static LibrariesDownloadGitHubraylib

The project focuses on providing synchronizable data structures for realtime and turn-based games, matchmaking, and ease of usage both on the server-side and client-side.

The mission of the framework is to be a standard netcode & matchmaking solution for any kind of project you can think of!

Why developers choose Colyseus:

  • ⚡️ Real-time state sync that just works → Define your state on the server and it automatically synchronizes to all clients, delta-compressed and binary-encoded.
  • ⚔️ Built-in matchmaking → Room-based architecture with filtering, queuing, and reconnection support out of the box.
  • 📈 Scalable → Go from 10 to 10,000+ CCU by scaling vertically or horizontally with Redis and load balancers.
  • 🛡️ Cheat-proof by design → Authoritative server model ensures game logic runs on the server, not the client.
  • 🛠️ Use the tools you already know → Built on Node.js and TypeScript with a simple, familiar API on both server and client.
  • 💙 Free forever → MIT licensed, even for commercial games.

See public roadmap for version 1.0.

🚀 Quickstart

Set up your own Colyseus server project for your game using npm create colyseus-app@latest:

npm create colyseus-app@latest ./my-server
cd my-server
npm start

Sponsors

The sustainability of the project relies on Colyseus Cloud subscriptions and sponsorships. If you are not using Colyseus Cloud, please consider sponsoring the project 💖

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Aymeric Chauvin

💬 💡

Brian Hay

🖋

Damian A. Pastorini

💬 📖 🐛

Darek Greenly

💬 🐛 💻

David Rydwanski

💬 💻

Dr. Burton

🧑‍🏫

Endel Dreyer

💻 📖 💡

Enriqueto

💼

Fazri Zubair

💼

Federico

🐛 💻

James Jacoby

💬 💡 🖋

Jonas Voland

💬 🐛 💻 🤔 💡

Kyle J. Kemp

💬 🐛 💻 🤔

Luke Wood

💬 🐛 💻

Milad Doorbash

🐛 💻

Nikita Borisov

🐛 💻 💼 🤔

Phil Harvey

📖

Sergey

🐛 💻

Sophie

💬 🐛 🤔

Tommy Leung

🧑‍🏫

digimbyte

📖

This project follows the all-contributors specification. Contributions of any kind are welcome!

Contributing

We encourage you to contribute to Colyseus! Please check out the Contributing guide for guidelines about how to proceed. Join us!

Everyone interacting in Colyseus and its sub-projects' codebases, issue trackers and chat rooms is expected to follow the code of conduct.

License

MIT

版本与发布记录

@colyseus/greeting-banner 共发布 21 个版本,首次发布于 2022/10/15;过去 12 个月发布了 13 个版本。

版本发布日期距今
4.0.3latest2026/09/231 个月前
4.0.22026/08/262 个月前
4.0.12026/07/213 个月前
4.0.02026/05/235 个月前
3.0.82026/01/269 个月前
3.0.72026/01/249 个月前

其他发布通道:preview → 2.0.5。

关于 @colyseus/greeting-banner 的常见问题

@colyseus/greeting-banner 是什么?

Greeting banner for Colyseus & Cloud

如何安装 @colyseus/greeting-banner?

在项目目录运行 npm install @colyseus/greeting-banner,或使用 pnpm add / yarn add / bun add。

@colyseus/greeting-banner 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@colyseus/greeting-banner 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@colyseus/greeting-banner 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >= 22.x。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@colyseus/greeting-banner 可以商用吗?

@colyseus/greeting-banner 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@colyseus/greeting-banner 的下载量有多少?

根据 npm 官方下载统计,@colyseus/greeting-banner 在 2026/10/11 – 2026/11/09 这 30 天内被下载 618,528 次,日均约 20,618 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@colyseus/greeting-banner 还在维护吗?

最新版本 4.0.3 发布于 2026/09/23(1 个月前);至今共发布 21 个版本,其中过去 12 个月发布了 13 个;首次发布于 2022/10/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。