为什么不使用这个呢？

• 此项目不是官方的，并且使用了一个大部分未记录的协议，Discord可以在未来的任何时间改变/破坏。
• 已经有一个官方游戏SDK的Rust包装器。
• 您的项目不是用Rust编写的。我们可能会在未来为这个crate添加C API，但到目前为止，这是一个仅限Rust的项目。

为什么要使用这个？

• 您使用Rust进行项目开发，并希望集成Discord提供的诸如丰富存在/活动等功能。
• 您不想依赖一个闭源共享库。
• 您喜欢冒险（尽管这个库也有一些自动测试！）

实现的功能

待办事项： 成就

活动（丰富存在）

命令

• 更新活动
• 清除活动
• 发送加入请求回复
• 发送邀请
• 接受邀请

事件

• 加入
• 观看
• 加入请求
• 邀请

其他

• 应用程序注册（Windows、Linux、Mac）

待办事项： 应用程序

⚠️ 语音

命令

• 设置输入模式
• 设置静音
• 设置免打扰
• 设置本地静音
• 设置本地音量

事件

• VOICE_SETTINGS_UPDATE_2 - 未记录，但此事件会在所有语音设置更改时触发，除 "设置本地音量" 之外。

待办事项： 图像

⚠️ 大厅

命令

• 创建大厅
• 更新大厅
• 删除大厅
• 连接大厅
• 断开连接大厅
• 更新成员
• 发送大厅消息
• 搜索 - 注意：这似乎完全损坏，并且从未返回结果。
• 连接语音
• 断开语音

事件

• 大厅更新
• 大厅删除
• 成员连接
• 成员更新
• 成员断开连接
• 大厅消息
• 正在说话

其他

• 集成网络

⚠️ 网络

覆盖层

注意：这些只在协议（可能）正确的情况下进行了测试，然而，覆盖层目前极其有限，因此我们无法测试覆盖层命令是否实际上能正确工作，因为我们的主要项目是Vulkan。

注意，还有其他一些情况下覆盖层无法工作。目前不支持Mac、支持Vulkan的游戏以及一般的老游戏。

另外注意，SDK及其文档在讨论覆盖层时使用了极其混乱的术语“解锁/锁定”，而此crate使用Visibility，即Visible或Hidden。

命令

• 切换可见性
• 打开活动邀请
• 打开公会邀请
• 打开语音设置 - 注意：据我所知，如果您的应用程序没有启用覆盖层（例如，因为它是Vulkan或CLI等），这将导致Discord崩溃。

事件

• 覆盖层更新

关系

命令

• 获取关系 - 注意：此命令并非直接从常规Game SDK暴露，而是在SDK初始化期间隐式执行。

事件

• 关系更新

待办事项：存储

待办事项？商店

用户

命令

• 获取当前用户
• 获取用户

事件

• 当前用户更新

⚠️ 弃用

这尚未由Discord官方宣布，但语音、大厅和网络功能将在未来的某个时间被弃用并移除。由于迄今为止仅实现了大厅功能，一旦官方公布，我们将将其标记为deprecated。

测试

不幸的是，Discord没有提供方便的自动化测试方法，因为它需要一个实际运行的Discord应用程序并登录，这使得自动化（尤其是无头）测试...令人烦恼。

目前，您需要手动启动2个不同的Discord应用程序（例如，Stable和Canary），并在同一台机器上使用不同的账户登录，然后一次运行一个测试。

活动

cargo test --features local-testing test_activity

大厅

注意：这没有测试大厅的search功能，因为该命令似乎无法正常工作，并且从未返回结果，即使REST等效命令确实返回了预期的结果。

cargo test --features local-testing test_lobbies

贡献

我们欢迎社区为此项目做出贡献。

请阅读我们的贡献指南以获取有关如何开始的更多信息。在您做出任何贡献之前，请阅读我们的贡献条款。

任何有意提交给Embark Studios项目包括在内的贡献，必须遵守Rust标准许可模型（MIT或Apache 2.0），因此将按照以下描述双重许可，不附加任何额外条款或条件。

许可

此贡献可以在以下两者中选择其一进行双重许可：

• Apache许可证2.0版（LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT许可证（《LICENSE-MIT》或 http://opensource.org/licenses/MIT）

由您选择。

为明确起见，“您”指Embark或任何其他贡献许可人/用户。