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

用心棒

如果这个库对你有帮助，请支持它：成为支持者

yojimbo 是一个用 C 语言编写的客户端/服务器游戏网络库。

它的设计围绕着竞争性多人游戏（如第一人称射击游戏）的网络需求。

一般来说，如果你有一个用 C 语言编写的游戏引擎，并且想为你的游戏实现网络功能，yojimbo 是一个非常好的选择。

它具有以下特点：

• 通过 连接令牌 进行密码学安全认证
• 客户端/服务器连接管理和超时
• 通过 UDP 发送加密和签名的数据包
• 数据包分片与重组
• 位打包器和序列化系统
• 用于时间敏感数据的不可靠无序消息
• 可靠有序消息，直到收到确认之前会进行积极重发
• 可以将大于最大数据包大小的数据块附加到可靠有序消息中
• 每个连接的延迟、抖动、丢包、带宽发送、接收及确认的估算

yojimbo 稳定且可用于生产环境。

设计假设

yojimbo 设计用于 100 人或以下的客户端/服务器游戏。

客户端和服务器必须使用 相同的配置。确保 ClientServerConfig、通道和消息工厂在双方完全一致，否则客户端和服务器无法协同工作。保持双方同步是你的责任。

yojimbo 是 单线程的。在同一个线程中调用所有客户端和服务器函数。如果你想让网络在独立线程中运行，也可以 — 只需确保每次 yojimbo 调用都发生在那一个线程上。

源代码

您可以通过从 GitHub 克隆它来获取最新的源代码：

  git clone https://github.com/mas-bandwidth/yojimbo.git

或者，您可以下载最新的版本。

作者

这个库的作者是 Glenn Fiedler。

Yojimbo 是建立在同一作者的其他开源库之上的：netcode 、 reliable 和 serialize。

如果您觉得这个软件有用，请考虑 成为支持者。谢谢!

贡献者

欢迎贡献——有关如何构建、测试和提交更改，请参阅 CONTRIBUTING.md。如需报告安全漏洞，请遵循 SECURITY.md，而不是打开公开问题。

许可证

BSD 三-Clause 许可证。

鸣谢

yojimbo 建立在 netcode、reliable 和 serialize 之上——发布 yojimbo 就意味着发布这四个组件。如果您在产品中使用 yojimbo，请在产品鸣谢中一并致谢：

yojimbo - Glenn Fiedler 和 Rowan Claude
netcode - Glenn Fiedler 和 Rowan Claude
reliable - Glenn Fiedler 和 Rowan Claude
serialize - Glenn Fiedler 和 Rowan Claude

许可证并不要求这样做。这是一个官方请求，尊重它会受到赞赏。公平的鸣谢让开源保持诚实。

yojimbo 还捆绑了 libsodium 和 tlsf ——它们各自的许可声明照常适用。