https://github.com/edqx/amongus-protocol

An implementation of the Among Us protocol in typescript.
https://github.com/edqx/amongus-protocol

among-us amongus implementation protocol typescript

Last synced: about 2 months ago
JSON representation

An implementation of the Among Us protocol in typescript.

• Host: GitHub
• URL: https://github.com/edqx/amongus-protocol
• Owner: edqx
• License: mit
• Archived: true
• Created: 2020-10-14T11:56:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-12T11:14:29.000Z (almost 4 years ago)
• Last Synced: 2024-11-06T03:44:52.363Z (3 months ago)
• Topics: among-us, amongus, implementation, protocol, typescript
• Language: TypeScript
• Homepage:
• Size: 1.07 MB
• Stars: 55
• Watchers: 6
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AmongUs-Protocol

This project is discontinued, please see [SkeldJS/SkeldJS](https://github.com/skeldjs/SkeldJS) for more updates.

![Alt text](asset/logo.png "Amongus Protocol")

See the [wiki](https://github.com/edqx/amongus-protocol/wiki) for more information on the protocol.

Documentation is available for preview at http://weakeyes.dev/amongus-protocol/

An implementation of the Among Us protocol made in Typescript

* Lightweight, 0 external dependencies.

* Comprehensive coverage of the Among Us protocol.

* Features full object and component system.

* Easy to install & use.

Data gathered from

* https://wiki.weewoo.net/wiki/

* https://github.com/alexis-evelyn/Among-Us-Protocol/wiki

* [Wireshark](https://www.wireshark.org/)

* [IDA](https://www.hex-rays.com/products/ida/)

* [Il2CppDumper](https://github.com/Perfare/Il2CppDumper)

* Impostor Discord server

* Helpful members

## Install

With NPM:

`npm install --save amongus-protocol`

Or clone with Git:

`git clone https://github.com/edqx/amongus-protocol`

## Example

```ts

import {

    AmongusClient,

    MasterServers,

    ColourID,

    HatID,

} from "amongus-protocol"

const server = MasterServers.EU[0];

const client = new AmongusClient({

    debug: false

});

await client.connect(server[0], server[1], "weakeyes");

const game = await client.join(process.argv[2]);

game.me.on("spawn", () => {

    game.me.setName("weakeyes");

    game.me.setColour(ColourID.Black);

    game.me.setHat(HatID.Plague);

});

```

## Notes

Recommended node: v14+

Recommended TS: 4.0+

This repository is licensed under the MIT license, I am not responsible for anything you do using this library.