Giter Club home page Giter Club logo

susbot's Introduction

SusBot

Showcase of bot

Bot for automatic deafening of players during the round in the game Among Us. Keep in mind it's my first C# project, so it might contain a lot of bugs. Consists of two modules, both needed for the operation. You should install AmongUs Module first, and then Discord Module.

Both can be found in the Releases tab.

AmongUs Module

The AmongUs Module requires MelonLoader, and is basically an mod for AmongUs, which reads the game data and dumps it in two files in the base game directory:

SusBot_gameStates.txt
SusBot_playerStates.txt
Installation of AmongUs Module
  1. Install MelonLoader. For AmongUs, you need to use the launch option "--melonloader.disablestartscreen", as else the game will crash.
  2. Launch the game. A Mods folder should have been generated in the game files.
  3. Put the SusBot_Mod.dll file in the Mods folder.
  4. You're done! Try joining a game, and see if the game data folders mentioned earlier appear in the Among Us folder.

Discord Module

The Discord Module reads the files dumped by the AmongUs Module, and uses them to detect changes in the game's state, and then deafens the alive players during the round.

Installation of AmongUs Module
  1. Create a Discord Bot, and get it's token ready. Make sure it has permissions to both read and write messages and deafen players.
  2. Unzip the SusBot_Discord.exe and it's corresponding files to a freely chosen folder.
  3. Create a new file, SusBot_Discord.txt. Here, you need to put these two lines:
AmongUsLocation|(location to Among Us directory here)
DiscordToken|(Discord Bot token you got in Step 1)

Save the file, and make sure it's in the same directory as SusBot_Discord.exe.

  1. Launch the bot starting using SusBot_Discord.exe

Alternate Step 3: Instead of creating the text file, you can also launch the bot using the command (in the commandline):

SusBot_Discord.exe [Among Us directory] [Discord Token]

Keep in mind the alternate way has shown to be buggy if there's any spaces in any of the directories.

Launching of bot

After installing the bot, you need to launch it every time you want to use the features. The bot doesn't remember any discord user - among us player - links, so you need to follow this instructions everytime you restart it.

  1. Make every player in the game use the command
sus!link [Among Us username]

This links their Among Us name with their Discord user.

  1. Use the command
sus!start

This binds the bot to your server, and makes it start working. When done playing, it can be unlinked using

sus!stop

Alternatively, you can just exit the program. Note the Among Us Nick - Discord user links will then be gone.

Bot commands

Other than the commands mentioned under Launching of bot, those commands are available:

sus!savelinks

Saves links between discord users and Among Us nicknames for future use. Those will be loaded on the next start.

susbot's People

Contributors

gronnmann avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.