-
-
-
-
-
-
-
-
- Free, open, Among Us proximity voice chat.
-
- Report Bug
- ·
- Request Feature
- ·
- INSTALLATION INSTRUCTIONS
-
- DONATE TO THE PROJECT - (all donations will be used for server costs or paying for college) -
- - - - -## Table of Contents - -* [About the Project](#about-the-project) -* [Installation](#installation) -* [Development](#development) - * [Prerequisites](#prerequisites) - * [Setup](#setup) -* [Contributing](#contributing) -* [License](#license) - - - - -## About The Project - -This project implements proximity voice chat in Among Us. Everyone in an Among Us lobby with this program running will be able to communicate over voice in-game, with no third-party programs required. Spatial audio ensures that you can only hear people close to you. - -## Installation - -Download the latest version from [releases](https://github.com/ottomated/CrewLink/releases) and run the `CrewLink-Setup-X.X.X.exe` file. You may get antivirus warnings, because this program hooks into the Among Us process to read game data. - -If you can, you should use a private server by deploying [this repository](https://github.com/ottomated/CrewLink-server). - -### Setup Instructions (click) - -[](https://www.youtube.com/watch?v=_8F4f5iQEIc "CrewLink Setup Instructions") - -## Development - -You only need to follow the below instructions if you are trying to modify this software. Otherwise, please download the latest version from the [github releases](https://github.com/ottomated/CrewLink/releases). - -Server code is located at [ottomated/CrewLink-server](https://github.com/ottomated/CrewLink-server). Please use a local server for development purposes. - -### Prerequisites - -This is an example of how to list things you need to use the software and how to install them. -* [Python](https://www.python.org/downloads/) -* [node.js](https://nodejs.org/en/download/) -* yarn -```sh -npm install yarn -g -``` - -### Setup - -1. Clone the repo -```sh -git clone https://github.com/ottomated/CrewLink.git -cd CrewLink -``` -2. Install NPM packages -```sh -yarn install -``` -3. Run the project -```JS -yarn dev -``` - - -## Contributing - -Any contributions you make are greatly appreciated. - -1. Fork the Project -2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -4. Push to the Branch (`git push origin feature/AmazingFeature`) -5. Open a Pull Request - - -## License - -Distributed under the GNU General Public License v3.0. See `LICENSE` for more information. - - -[license-shield]: https://img.shields.io/github/license/ottomated/CrewLink.svg?style=flat-square -[license-url]: https://github.com/ottomated/CrewLink-server/blob/master/LICENSE -[appveyor-shield]: https://img.shields.io/appveyor/build/ottomated/crewlink -[appveyor-url]: https://ci.appveyor.com/project/ottomated/crewlink +