Skip to content

Latest commit

 

History

History
149 lines (106 loc) · 4.64 KB

README.md

File metadata and controls

149 lines (106 loc) · 4.64 KB
Raw

CrewLink for Linux

  • Requires running Among Us via Steam, version 2020.12.9.
    • Other Steam versions could work, but version detection is not implemented. See src/main/hook.ts
    • The offsets for the itch.io versions have not yet been documented?
  • Uses my fork of memoryjs which implements just enough of the API for CrewLink.
    • Can't detect if the process quits. If Among Us restarts, restart CrewLink.
  • Doesn't launch Among Us, so there's no parent process relationship; ptrace security gets in the way
  • Please report issues on this fork's issue tracker

Running

wget "https://github.com/zbanks/CrewLink/releases/download/v1.2.1/CrewLink-1.2.1.AppImage"
chmod +x CrewLink-1.2.1.AppImage

echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
./CrewLink-1.2.1.AppImage

Notes

Tested/developed on Ubuntu 16.04.6 LTS

Building from source

git clone https://github.com/zbanks/CrewLink
cd CrewLink
yarn install 

# Disable ptrace scope security, so we can read the process memory
echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

# Launch CrewLink (Among Us should be already running)
yarn dev

GPL-3.0 License Appveyor Build


Logo

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

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 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.

Setup Instructions (click)

Setup Video

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.

Server code is located at 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.

npm install yarn -g

Setup

  1. Clone the repo
git clone https://github.com/ottomated/CrewLink.git
cd CrewLink
  1. Install NPM packages
yarn install
  1. Run the project
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.