Proximity-Based Voice Chat for Any Game

Description

Project based on proxi-chat by BGoodes.

This project aims to add proximity-based voice chat to any game by bringing a web-based platform.

Installation

For Server

1. Clone the repository.
2. Go to server/ folder.
3. Then install and run the app: npm install & npm run dev.
4. Change .env.example to .env and fill in the necessary information.
5. To start the server, run npm run dev.

For Minecraft Plugin

1. Clone the repository.
2. Go to minecraft-plugin/ folder.
3. With idea, open the project, package projet with Maven.
4. Copy the jar file in the target folder to your server's plugin folder.
5. After first running, change the config in config.yml in the plugin folder.
6. Add in config file, the generated token at server_token.
7. Restart the server.

For Make a Token

1. Go to server/ folder.
2. Go on scripts/generateToken.js and read cotent to understand how to use.
3. Run npm run token.

Build And Run With Docker

1. Clone the repository.
2. Change .env.example (in server/ folder) to .env (in root folder) and fill in the necessary information.
3. Run the following commands:

docker build -t proxichat/server ./server/
docker compose up

License

This project is licensed under the MIT License. See the LICENCE file for details.