Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ottomated/CrewLink
Free, open, Among Us Proximity Chat
https://github.com/ottomated/CrewLink
among-us amongus
Last synced: 3 days ago
JSON representation
Free, open, Among Us Proximity Chat
- Host: GitHub
- URL: https://github.com/ottomated/CrewLink
- Owner: ottomated
- License: gpl-3.0
- Created: 2020-11-11T01:18:11.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-18T22:25:15.000Z (about 2 years ago)
- Last Synced: 2024-11-04T00:51:39.049Z (7 days ago)
- Topics: among-us, amongus
- Language: TypeScript
- Homepage:
- Size: 1.89 MB
- Stars: 3,307
- Watchers: 319
- Forks: 562
- Open Issues: 292
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[![GPL-3.0 License][license-shield]][license-url] [![Appveyor Build][appveyor-shield]][appveyor-url]
CrewLink
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