AUProximity 开源项目安装与配置指南

1. 项目基础介绍

AUProximity 是一个开源的近距离语音聊天平台，主要针对 Among Us 游戏设计。该项目允许玩家在游戏中实现基于位置的声音聊天。它适用于个人在公共大厅中的使用，同时也支持私人服务器和定制解决方案。

主要编程语言：TypeScript、Vue

2. 项目使用的关键技术和框架

• WebRTC：用于实现实时通信和声音数据的传输。
• WebSockets：用于客户端和服务器之间的数据交换。
• skeldjs：用于与 Among Us 公共大厅进行接口的库。
• Vue：用于构建用户界面的前端框架。

3. 项目安装和配置的准备工作与详细步骤

准备工作

在开始安装之前，请确保您已经安装以下软件：

• Node.js：建议使用最新稳定版。
• yarn：JavaScript 包管理工具。

安装步骤

步骤 1：克隆项目

首先，您需要将项目克隆到本地计算机。打开命令行工具，执行以下命令：

git clone https://github.com/cybershard/auproximity.git
cd auproximity

步骤 2：安装依赖

在项目目录中，使用 yarn 安装所有依赖项：

yarn install

步骤 3：运行开发服务器

在项目目录中，运行以下命令以启动开发服务器：

yarn serve

此时，服务器将监听端口 8079，前端界面将监听端口 8080。

步骤 4：配置 WebUI

接下来，进入 WebUI 目录，并运行以下命令以启动前端界面：

cd auproximity-webui
yarn serve

现在，您应该能够在浏览器中访问两个界面：服务器的地址通常是 http://localhost:8079，WebUI 的地址通常是 http://localhost:8080。

步骤 5：部署到生产环境

在准备将项目部署到生产环境时，您需要构建项目，并确保前端界面与服务器位于同一域下。构建前端界面的命令通常是：

yarn build

构建完成后，将构建的静态文件放在服务器上的适当位置，并配置 SSL 代理（如 nginx）或使用 PaaS 服务（如 Heroku）。

请注意，项目中提供的 heroku-postbuild 脚本仅用于 Heroku 部署，不应在开发和生产测试中使用。

以上就是 AUProximity 开源项目的详细安装和配置指南。按照这些步骤操作，您应该能够成功运行该项目。