🚩 This project is archived! 🚩
This was really fun! I enjoyed reverse-engineering Among Us and learning a lot of new things. Right now I don't play the game anymore and I don't find it fun to work on this anymore. Luckily, it isn't yet developed enough that anyone depends on it.
While this definitely was and would've been the best Among Us JS library, you'll have to find alternatives.
About Among JS
Among JS is a set of utilities for interacting with the Among Us protocol written in TypeScript. It's composed of several self-contained libraries which are all published to NPM:
- Data: constants, enums, types, static game data, and more (docs)
- Hazel: a library for interacting with the Hazel network protocol (docs)
- Packets: rich Among Us packet parsing and serialization with a programmer-friendly API (docs)
- Sus: simple and expressive object-oriented library for easily making bots and clients (docs)
- Util: general utilities for reading bytes and more (docs)
Among JS was designed with browser support in mind, meaning when the Hazel library supports WebSocket transports you'll be able to run Among Us bots and clients fully on the web as well as Node.js!
In it's current state not all packets and events are supported but I'm focusing on rapid iteration. Every current feature is fully manually tested and stable. Currently unit test coverage is low but increasing.
You can find more information about the protocol in this freshly made wiki I helped create.
They're a bit of a WIP, but feel free to read the documentation. If you have any feedback, create a GitHub issue or shoot be a DM on Discord @Kognise#6356.
Requirements
- Node.js 12.x or higher
Development
git clone https://github.com/kognise/among-js.git
cd among-js
yarn install && yarn dev
node example.js (to run the example file)