Skip to content

Latest commit

 

History

History
100 lines (79 loc) · 4.36 KB

README.md

File metadata and controls

100 lines (79 loc) · 4.36 KB
Raw

banner

AmongUsIO

ci docs codacy python versions project version discord made with python license black gitter

No active development

I currently dont have a lot of time in which i could work on this library due to things like school. I use the time i have to work on some private projects in which i hopefully can use this library in the future, which will allow me to find bugs and issues more quickly. I'm open to contributions and feedback/issues and am still trying to fix them as quickly as possible :) Please check out CONTRIBUTING.md if you want to contribute code. I will be working on this more when i have time again, ETA around july (when im done with school).

Note

This repository is mirrored from Gitlab to Github. Most features like Issues, MRs/PRs etc. are disabled on Github, please use the Gitlab repository for these

Info

AmongUsIO is an asynchronous Among Us client written in Python. It tries to expose methods for features of the official Among Us client, like meeting starts and ends

Made by reverse engineering with Wireshark and by reading the source code of an unofficial Among Us server

Features

  • Supports custom Among Us servers like Impostor (this server does not support "spectating" though as it's kinda hacky)
  • Join Among Us lobbies
  • Receive and send chat messages
  • Get information about the lobby and the other players
  • Move the character around, for example letting it follow people
  • "Spectate". This makes the connection kind of read only, you cannot move etc. but the Client can receive events like meetings while being completely invisible (one drawback: we still need one player slot for this, as the client technically counts as a player)

Documentation

Installation

# currently only released on testpypi by CI
python -m pip install --index-url https://test.pypi.org/simple/ amongus

Development version:

python -m pip install git+https://gitlab.com/TECHNOFAB/amongusio.git
# or
python -m pip install git+https://github.com/TECHNOFAB11/amongusio.git

Example

import amongus

client = amongus.Client(name="Bot")

@client.event
async def on_ready():
    # connected and ready to send commands, eg:
    await client.join_lobby("ABCDEF")

client.run(region="EU")

see the examples folder for more

Roadmap / TODO

see TODO.md

Development & Tools

Parse Wireshark data and print the parsed packets

python -m amongus --parse <Wireshark Data (example: 00112233445566)>

For more information:

python -m amongus --help