英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

火龙果

Pitaya 是一个简单、快速且轻量级的游戏服务器框架，支持集群，并通过 C SDK 提供 iOS、Android、Unity 等客户端库。它为分布式多人游戏和服务器端应用提供了基础开发框架。

入门指南

先决条件

• Go >= 1.16
• etcd（可选，用于服务发现）
• nats（可选，用于发送和接收 RPC）
• docker（可选，用于在容器中运行 etcd 和 nats 依赖）

安装

克隆仓库

git clone https://github.com/topfreegames/pitaya.git

设置火龙果依赖项

make setup

黑客火龙果

这里是运行火龙果的一个例子：

启动 etcd（此命令需要 docker-compose，并将在本地运行一个 etcd 容器。如果需要，也可以在不使用 docker 的情况下运行 etcd。）

cd ./examples/testing && docker compose up -d etcd

从 cluster_grpc 示例运行连接器前端服务器

make run-cluster-grpc-example-connector

从 cluster_grpc 示例运行房间后端服务器

make run-cluster-grpc-example-room

现在应该有 2 个 pitaya 服务器在运行，一个是前端连接器，另一个是后端房间。要发送请求，请使用 pitaya 的 REPL 客户端 pitaya-cli。

$ pitaya-cli
Pitaya REPL Client
>>> connect localhost:3250
connected!
>>> request room.room.entry
>>> sv-> {"code":0,"result":"ok"}

运行测试

make test

此命令将运行单元测试和端到端测试。

贡献

待办事项

作者

• TFG Co - 初始工作

许可

MIT 许可证

致谢

• nano 作者，感谢他们构建了 pitaya 所基于的框架。
• pomelo 作者，感谢他们在分布式设计和协议上的启发。

安全

如果您发现了安全漏洞，请发送电子邮件至 security@tfgco.com

资源

• 其他与 pitaya 相关的项目

  • libpitaya-cluster
  • libpitaya
  • pitaya-admin
  • pitaya-bot
  • pitaya-cli
  • pitaya-protos

• 文档

  • API 参考
  • 深入文档

• 演示

  • 使用 pitaya 和 WebSocket 在约 100 行代码内实现聊天室（改编自 nano 的示例）
  • Pitaya 集群模式示例
  • 使用 protobuf 协议的 Pitaya 集群模式示例