Giter Club home page Giter Club logo

impostorcord's Introduction

impostorCord

Impostor is a self hostable among us server that also has plugin support

ImpostorCord is a plugin for impostor that automatically mutes and unmutes players according to their state

Usage

obviously you have to install impostor itself which requires .NET 5.0 which is currently in preview

also make sure you download the beta (1.2.X) version NOT the stable version (1.1.0), the stable version has no plugin support yet

get the latest release from the releases page and put the contents of the zip in your impostor folder

this is what your direvctory should look like:

├─ Impostor.Server(.exe)
├─ config.impostorCord.json
├─ config.json
├─ libraries
  └─(bunch of dependency files)
└─ plugins
  └─ ImpostorCord.dll

you also need a discord bot token and there are many guides on the internet about how to do that so im not gonna get in to it here

the permissions that we are gonna need are mute members, deafen members and send message or put it on administrator but that's a bit risky if someone finds your token some bad stuff can happen to your discord server

after doing all of those open config.impostorCord.json and put your bot token in the <TOKEN> section

after all of that you should be able to start the server by opening Impostor.Server(.exe)

you can also optionally add all of the emojis in emojis.zip

Commands

command alias syntax usage
help - help <optional:command name> provides help about commands and their syntax
newgame ng newgame <game code> connects specified game to a voice chat
endgame eg endgame <game code> disconnects specified game from a voice chat (user must be in related voice chat)
join j join <color> join user as specified color
forcejoin fj forcejoin <user to force join> join specified user to specified color (mention specified user)
kick k kick <color> clears user data from specified color
deadtalk dt deadtalk <true/false> allow dead players to talk during tasks or not
players p players list all players in the current game

Compiling

add the DSharpPlus SlimGet repo (here is how)

if you are on linux you can just run the build.sh script like

./build.sh 
#or
./build.sh release

and it will create the files for you in bin/<Debug\Release>/net5.0/publish/, put those files in the root directory of your server (as explained in usage)

on windows assuming you are using the cli these are the commands you should run in order:

(-c Release in case you want to build the release version)

dotnet restore
dotnet build (-c Release)
dotnet publish (-c Release)

also reading the Impostor plugin docs may be helpful: https://github.com/Impostor/Impostor/blob/dev/docs/Writing-a-plugin.md

Credits

Impostor for obvious reasons i hope

DSharpPlus for C# discord api

Amongcord as this project's functionality and commands are heavily inspired by amongcord

impostorcord's People

Contributors

tuxinal avatar mr-vit avatar

Watchers

James Cloos 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.