Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only

Module among-us-client

among-us-client

Get and modify data from a local among us game. This library was NOT made so you can cheat in public lobbies. That's for losers.

This library is NOWHERE near stable. There are a lot of known bugs and also a ton of missing features. Expect every new commit to contain a breaking change. We're looking for contributors!

Install

Requirements

  • Windows
  • Latest among us version (2020.12.9)
  • Node.js 14+

Install

This library will be published to npm when we think it's ready.
For now you can:

  • Clone or download this repository
  • Install all dependencies and dev-dependencies (npm i)
  • Transpile the source code to javascript, if you don't use typescript (tsc)
  • Import the AmongUsProcess where you need it!

Documentation

Link: https://googlefeud.github.io/among-us-client/

Examples

Listen to in-game events

const AmongUsProcess = require("among-us-client");

// Scan for an among us process
AmongUsProcess.scan((proc) => {
    console.log("Connected to an among us process!");
    
    proc.on("joinGame", (game) => {
        console.log(`User joined a game with code ${game.code}`);
        // Set the player speed 
        game.setPlayerSpeed(10); // Super super fast!
    });

    proc.on("leaveGame", (game) => {
        console.log(`User left a game with code ${game.code}`);
    });

    proc.on("startGame", (game) => {
        console.log(`Game with code ${game.code} is starting!`);
    });

    proc.on("endGame", (game) => {
        console.log(`Game with code ${game.code} has ended!`);
    });

    proc.on("close", () => {
        console.log("User closed Among Us!");
    });

    proc.on("tasks", (game) => {
        console.log(`There are ${game.getTotalTasks() - game.getCompletedTasks()} tasks left!`);
    });
});

Get all alive impostors

proc.on("startGame", game => {
    console.log(`Impostors: `, game.players.filter(p => p.isImpostor && !p.isDead && !p.disconnected).map(p => p.name));
});

Do something when somebody gets murdered

Note: The killer parameter is a complete guess - the player who is the closest to the body is assumed to be the killer.

proc.on("playerDie", (player, killer) => {
    console.log(`${player.name} got murdered by ${killer ? killer.name:"unknown"}!`);
});

Exports

ScanCallbacktype ScanCallbackScanCallback
AmongUsProcessSettingsinterface AmongUsProcessSettingsAmongUsProcessSettings
AmongUsProcessclass AmongUsProcessAmongUsProcess

Re-Exports

exports * from Collectorsmodule CollectorsCollectors
exports * from Structuresmodule StructuresStructures