edqx / amongus-protocol

An implementation of the Among Us protocol in typescript.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AmongUs-Protocol

This project is discontinued, please see SkeldJS/SkeldJS for more updates.

Alt text

See the 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

Install

With NPM: npm install --save amongus-protocol

Or clone with Git: git clone https://github.com/edqx/amongus-protocol

Example

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.

About

An implementation of the Among Us protocol in typescript.

License:MIT License


Languages

Language:TypeScript 100.0%