@skeldjs/client
TypeScript icon, indicating that this package has built-in type declarations

2.15.49 • Public • Published

Skeld JS client

@skeldjs/client

This package contains a complete programmable Among Us client, and while it is one package of a bigger project, skeldjs, it is intended to be installed on its own with npm install --save @skeldjs/client or yarn add @skeldjs/client.

You can view auto-updating documentation for this package hosted at github pages at https://skeld.js.org/modules/client.html

Basic Usage

Join a game

const client = new SkeldjsClient("2021.4.25");

await client.connect("EU", "weakeyes");

await client.joinGame("ABCDEF");

await client.me.control.checkName("weakeyes");
await client.me.control.checkColor(ColorID.Blue);

Host a game

const client = new SkeldjsClient("2021.4.25");

await client.connect("EU", "weakeyes");

await client.createGame({
    players: 10,
    map: skeldjs.MapID.TheSkeld,
    impostors: 2,
});

await client.me.control.setName("weakeyes");
await client.me.control.setColor(ColorID.Blue);

Advanced Usage

Host a game and say hello to everyone that joins

const client = new SkeldjsClient("2020.3.5.0");

await client.connect("EU", "weakeyes");

await client.createGame({
    players: 10,
    map: skeldjs.MapID.TheSkeld,
    impostors: 2,
});

await client.me.control.setName("weakeyes");
await client.me.control.setColor(ColorID.Blue);

client.on("player.setname", async ev => {
    client.me.control.chat("Hello, " + ev.name + "!");
});

Search for games and join a random one

const client = new SkeldjsClient("2021.4.25");

await client.connect("EU", "weakeyes");

const games = await client.findGames();
const game = games[Math.floor(Math.random() * games.length)];

const code = await client.joinGame(game.code);

console.log("Joined " + game);

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
2.15.493latest

Version History

VersionDownloads (Last 7 Days)Published
2.15.493
2.15.481
2.15.471
2.15.461
2.15.452
2.15.441
2.15.431
2.15.421
2.15.412
2.15.401
2.15.391
2.15.383
2.15.371
2.15.361
2.15.352
2.15.341
2.15.333
2.15.322
2.15.311
2.15.301
2.15.291
2.15.251
2.15.241
2.15.231
2.15.221
2.15.211
2.15.201
2.15.191
2.15.181
2.15.172
2.15.161
2.15.151
2.15.141
2.15.132
2.15.121
2.15.111
2.15.101
2.15.91
2.15.81
2.15.71
2.15.61
2.15.51
2.15.42
2.15.31
2.15.21
2.15.11
2.15.01
2.14.361
2.14.351
2.14.342
2.14.332
2.14.322
2.14.311
2.14.301
2.14.292
2.14.281
2.14.271
2.14.261
2.14.251
2.14.231
2.14.222
2.14.191
2.14.181
2.14.171
2.14.161
2.14.151
2.14.141
2.14.131
2.14.121
2.14.111
2.14.102
2.14.91
2.14.81
2.14.71
2.14.61
2.14.51
2.14.41
2.14.31
2.14.22
2.14.11
2.14.01
2.13.101
2.13.91
2.13.81
2.13.72
2.13.61
2.13.51
2.13.41
2.13.31
2.13.21
2.13.11
2.13.01
2.12.61
2.12.51
2.12.31
2.12.21
2.12.11
2.12.01
2.11.191
2.11.181
2.11.171
2.11.161
2.11.151
2.11.141
2.11.131
2.11.121
2.11.112
2.11.101
2.11.91
2.11.81
2.11.71
2.11.61
2.11.51
2.11.41
2.11.31
2.11.21
2.11.12
2.11.01
2.10.221
2.10.211
2.10.201
2.10.192
2.10.182
2.10.16-01
2.10.152
2.10.141
2.10.121
2.10.112
2.10.101
2.10.81
2.10.71
2.10.61
2.10.51
2.10.43
2.10.31
2.10.21
2.10.11
2.10.02
2.9.51
2.9.41
2.9.21
2.9.11
2.9.01
2.6.201
2.6.191
2.6.182
2.6.171
2.6.151
2.6.141
2.8.21
2.8.12
2.7.31
2.7.21
2.8.01
2.7.11
2.7.02
2.6.121
2.6.112
2.6.101
2.6.91
2.6.81
2.6.71
2.6.61
2.6.51
2.6.41
2.6.33
2.6.11
2.6.01
2.5.111
2.5.103
2.5.82
2.5.71
2.5.61
2.5.41
2.5.31
2.5.21
2.5.11
2.4.11
2.3.131
2.3.91
2.3.81
2.3.71
2.3.51
2.3.41
2.3.32
2.3.21
2.2.232
2.2.221
2.2.211
2.2.201
2.2.191
2.2.181
2.2.171
2.2.161
2.2.151
2.2.141
2.2.131
2.2.121
2.2.111
2.2.101
2.2.91
2.2.81
2.2.71
2.2.61
2.2.51
2.2.41
2.2.31
2.2.22
2.1.142
2.1.122
2.1.111
2.1.101
2.1.71
2.1.61
2.1.51
2.1.42
2.1.31
2.1.21
2.0.21
2.0.11
2.0.02
0.0.41
0.0.31
0.0.23
0.3.21
0.3.01
0.2.161
0.2.141
0.2.132
0.2.121
0.2.111
0.2.101
0.2.71
0.2.61
0.2.51
0.2.11
0.1.51
0.1.41
0.1.01
0.0.11

Package Sidebar

Install

npm i @skeldjs/client

Weekly Downloads

289

Version

2.15.49

License

GPL-3.0-only

Unpacked Size

113 kB

Total Files

94

Last publish

Collaborators

  • topsno