AUProximity 使用指南

AUProximity 使用指南

auproximity AUProximity is an open source proximity voice chat platform, primarily aimed at Among Us. 项目地址: https://gitcode.com/gh_mirrors/au/auproximity

1. 项目介绍

AUProximity 是一个开源的近距离语音聊天平台，主要面向 Among Us 游戏玩家。它允许玩家在公共游戏大厅中连接以提供近距离语音服务，也可以作为插件运行在 Impostor、NodePolus 或其他私人服务器上。AUProximity 旨在提供一个易于扩展的客户端和服务器架构，支持多种位置数据提供者，如服务器插件和BepInEx 模组。

2. 项目快速启动

以下是在本地环境快速启动 AUProximity 的步骤：

安装依赖

确保你已经安装了 yarn。如果没有安装，可以通过以下命令安装：

npm install -g yarn

然后，在你的项目目录中运行以下命令来安装所有依赖：

yarn install

启动服务

在 auproximity 目录中运行以下命令来启动服务器：

yarn serve

在 auproximity-webui 目录中运行以下命令来启动 WebUI：

yarn serve

在开发模式下，服务器将监听端口 8079，WebUI 将监听端口 8080。

注意

对于 Heroku 部署，项目包含一个 heroku-postbuild 脚本。但请注意，这个脚本仅用于 Heroku 部署，不应在开发或生产测试中使用，因为它会导致问题。

3. 应用案例和最佳实践

应用案例

• 个人使用：在公共大厅中使用 AUProximity 进行语音聊天。
• 私人服务器：作为插件在私人服务器上运行，享受更多玩家和功能的支持。

最佳实践

• 安全性：在生产环境中，确保使用 SSL 代理，如 nginx，或部署在支持 SSL 的 PaaS 平台，如 Heroku。
• 扩展性：客户端可以轻松扩展，以创建桌面应用、与 Discord RPC 接口，甚至添加小地图等特性。

4. 典型生态项目

AUProximity 生态系统中的典型项目包括：

• skeldjs：由 edqx 开发的库，用于与公共大厅接口。
• BepInEx 模组：用于发送位置数据到后端服务器的模组。

以上就是 AUProximity 的使用指南。希望这些信息能够帮助你顺利地启动和运行这个项目。

auproximity AUProximity is an open source proximity voice chat platform, primarily aimed at Among Us. 项目地址: https://gitcode.com/gh_mirrors/au/auproximity