Skip to content

Latest commit

 

History

History
899 lines (773 loc) · 52.8 KB

README.md

File metadata and controls

899 lines (773 loc) · 52.8 KB

Discord eisbison banner eisbison infographic

The Other Roles

The The Other Roles, is a mod for Amongs Us which adds many new roles, new Settings, new Custom Hats and support for 10+ Player Lobbies to the game. Even more roles are coming soon :)

Impostors Crewmates Neutral
Bad Child Child Jester
Camouflager Detective Jackal
Cleaner Engineer Sidekick
Eraser Hacker
ImpLover Lover
Godfather (Mafia) Lighter
Mafioso (Mafia) Mayor
Janitor (Mafia) Medic
Morphling Seer
Trickster Sheriff
Vampire Shifter
Warlock Snitch
Spy
Swapper
Time Master
Tracker

The Role Assignment sections explains how the roles are being distributed among the players.

Releases

Among Us - Version Mod Version Link
2021.4.14s v2.5.0 Download
2021.4.14s v2.4.0 Download
2021.4.14s v2.3.0 Download
2021.4.14s v2.2.2 Download
2021.4.12s v2.2.1 Download
2021.4.12s v2.2.0 Download
2021.3.31.3s v2.1.0 Download
2021.3.31.3s v2.0.1 beta Download
2021.3.31.3s v2.0.0 beta Download
2021.3.5s v1.8.2 Download
2021.3.5s v1.8.1 Download
2021.3.5s v1.8 Download
2021.3.5s v1.7 Download
2021.3.5s v1.6 Download
2021.3.5s v1.5 Download
2021.3.5s v1.4 Download
2021.3.5s v1.3 Download
2020.12.19s v1.1 Download
2020.12.19s v1.0 Download

Changelog

Click to show the Changelog

Version 2.5.0

  • New Role: Security Guard
  • Fixed a bug where the game would stop after the first meeting
  • Fixed a bug where killing with the hotkey Q ignored shields

Version 2.4.0

  • New Role: Warlock
  • Added an option that allows ghosts to see the roles and remaining tasks of other players
  • Added options to configure Morph & Camo duration
  • Added hotkeys to the custom buttons (Q for the buttons that are on the same place as the kill button, F for the buttons that are above the kill button)
  • Fixed an oversight which made StreamerMode only work as host
  • Fixed an oversight which required Jackals to finish Tasks, after Sidekick was promoted
  • Fixed an oversight which made Sidekicks not promote, if the Jackal disconnected
  • Fixed a bug where the Trickster box was invisible
  • Fixed a bug where changes to the server ip and port would only be applied if the game was restarted
  • Added a way to get the 2 Hidden Colors

Version 2.3.0

  • New Role: Cleaner
  • Added 12 new Colors
  • We added support for creating Custom Hats. New hats are coming with the next version, but you can already create and submit your own hats on Discord.
  • Added the option to hide the name of players with an unknown role
  • Added Trickster Box vent animation. Thanks to Drakoni
  • You can now change the custom server ip/port right inside the game
  • The Jackal, the Sidekick and the Jester now have fake tasks
  • Added outlines, to show who you're targetting with your ability. Thanks to Sihaack for part of the code.
  • Added a streamer mode to Among Us, which hides lobby codes, the ip of your custom server and the port of your custom server. You can also modify the text that replaces the lobby code, check Settings for more details.
  • Changed Meeting Hud Layout when playing with more than 10 players
  • Fixed a bug where ImpLovers would hardly spawn
  • Fixed a bug where players could get stuck on ladders/platforms when being rewinded
  • Fixed a bug where players could only use quickchat
  • Fixed a bug which prevented to play in Freeplay mode
  • Fixed a bug which moved the Ping info off-screen

Version 2.2.2

  • Among Us version 2021.4.14s compatibility
  • Improved the block votes on emergency meeting option

Version 2.2.1

  • Trickster: The vent button now has a custom texture. Fixed a bug where the Trickster could clip out of bounds when his box was close to a wall.
  • Fixed a bug where the Bad Child's kill button went on cooldown when someone else performed a kill
  • Fixed a few bugs with footprints, Seer souls and the Vampire delayed kill
  • Fixed a bug where the Child was banned for hacking (because of its reduced kill cooldown)
  • Improved the version handshake

Version 2.2.0

  • Works with the latest Among Us version (2021.4.12s)
  • Added support for 10+ player lobbies on custom servers: Check the Custom Servers and 10+ Players section. During meetings use the up/down keys, on vitals use the left/right keys.
  • Added a new Impostor role: The Trickster check the Trickster section for more infos
  • You can now set how long the Time Master shield lasts
  • The host now sees for how long the lobby will remain open
  • We changed the look/layout of the settings
  • Added a new option that deactivates skipping in meetings (if the player does not vote, he votes himself)
  • You can now choose whether the Eraser is able to erase the Spy/Impostors or not
  • Fixed a bug where a Lovers win wasn't displayed properly
  • Fixed the Among Us bug where people were unable to move after meetings
  • We added a version checking system: The host can only start the game if everyone in his lobby has the same version of the mod installed (he will see, who is using a wrong version). This prevents hacking in public lobbies and bugs because of version missmatches.
  • Fixed a bug where the Child Impostor had the same cooldowns as normal Impostors
  • Fixed a bug where the Vampire/Janitor/Mafioso would lose their kill button after being erased
  • The Child is now able to use ladders and it can do all the tasks right away

Version 2.1.0

  • New Role: Spy
  • Eraser: The Eraser can now also remove the role of other Impostors. This enables him to reveal the Spy, but might result in removing the special ability of his partner.
  • Camouflager: The Child age/size will now also be hidden, to allow the Child Impostor to kill during camouflage

Hotfix 2.0.1

  • Fixed a bug where camouflaged players would get stuck on ladders/platforms on the airship
  • Introduced a one second cooldown after the Morphling sampled another player
  • The Child can now always reach all usables (ladders, tasks, ...)
  • We removed a bug, where some footprints remained on the ground forever
  • We removed a bug, where the Detective didn't see the right color type when reporting a player
  • We changed the Jester win and Child lose conditions, they're not being affected by server delays anymore

Changes in 2.0.0

  • New button art created by Bavari
  • New mod updater/installer tool created by Narua and Jolle. Check the Installation section for more details.
  • Custom options: Introduced customizable presets. Starting with 2.0.0, settings can be copied and used with higher versions (2.0.0).
  • Time Master rework: Check Time Master for more information
  • Medic: The Medic report changed, it only shows the time since death (see Detective)
  • Detective: The Detective now sees the name/color type of the killer when he reports a dead body (ability moved from the Medic to the Detective)
  • Lighter: We changed and tried to nerf the Lighter, see the Lighter section for more details.
  • Seer: As the role didn't work the way it was, we completely changed it. We're still working on the role, for now we're trying a few things. Check the Seer section to get more details about the new Seer.
  • Shifter: We reworked the Shifter, he is now part of the crew. Check out the Shifter sections for more details.
  • Hacker: The Hacker is basically the old Spy. We added the option to only show the color type instead of the color on the admin table.
  • Camouflager: Now also overrides the information of other roles, check the Camouflager section for more details.
  • Morphling: Now also overrides the information of other roles, check the Morphling section for more details
  • Child: The Child can now be a Crewmate Child or an Impostor Child, check the Child section for more details
  • Eraser: The Eraser, a new Impostor role, is now part of the mod. Check the Eraser section for more details
  • New options:
    • You can now set the maximum number of meetings in a game: Every player still only has one meeting. The Mayor can always use his meeting (even if the maximum number of meetings was reached). Impostor/Jackal meetings also count.

Hotfix 1.8.2

  • Add map and Impostor count to lobby settings.
  • Fixed bugs where changing players to be the Sidekick didn't reset all the effects of their previous role.

Hotfix 1.8.1 Resolves bugs that occured when the Jackal recruited a Medic, Swapper and Tracker

Changes in v1.8:

  • New Roles: Added the Jackal and Sidekick roles
  • Vampire: Medic report shows the right info now. A bitten Swapper is not able to swap if he dies at the beginning of a meeting. One can now set the cooldown and whether a normal kill is possible when a target is next to a garlic or not.
  • Lover: New option that sets how often an ImpLover appears. If a Lover is exiled, his partner doesn't spawn a dead body anymore.
  • Cooldowns now stop cooling down, if a player sits inside a vent.
  • Fixed a bug that prevented the game from continuing after a meeting (for an edge case with Lovers)
  • If two players try to kill each other at the same time both should die (e.g. Sheriff vs Impostor)
  • We added a description for your current role right above the task list
  • Added a description for the Role Assignment System


Changes in v1.7:

  • New Roles: The Vampire, the Tracker and the Snitch are now in the game
  • The role assignment system has been changed
  • Impostors now see a blue outline around all vents of the map, if the Engineer sits inside one of them


Changes in v1.6:

  • This update is a small hotfix, fixing the bug where some people were unable to join lobbies.
  • The Child can't be voted out anymore before it turns 18, hence games can't end anymore because the Child died.
  • Footprints are no longer visible to the Detective, if players are inside vents.


Changes in v1.5:

  • Time Master - Buff: He is not affected by his rewind anymore, which gives him more utility. Players will now be rewinded out of vents.
  • Child - Nerf: The Child now grows up (see Child) and becomes a normal Crewmate at some point. A growing Child is not killable anymore. Some tasks are still not doable for the small Child, we are working on that. But eventually when growing up it can do all the tasks as it's size increases.
  • Seer - Nerf: Added an option that sets how often the Seer mistakes the player for another.
  • Hacker - Nerf: The Hacker now only sees the additional information when he activates his "Hacker mode". That should stops the Hacker from camping the admin table/vitals.
  • Other: Camouflager/Morphling cooldowns were fixed. Custom regions code was removed to enable 3rd party tools. Some minor bugfixes.

Changes in v1.4:

  • Fixing a Camoflager/Morphling animation bug
  • Fixing a bug where the Swapper could swap votes even if they are dead
  • The custom cooldown buttons now render the cooldown progress (the grey overlay) in the right way (v1.3 introduced the bug)
  • Players in vents are not targetable anymore by the role actions, the button does not activate (e.g. Seer revealing, Morphling sample). Exception: Impostor killing an Engineer in a vent

Changes in v1.3:

  • Adds support for the Among Us version 2021.3.5s
  • Fixes a bug where a an edge case caused all players to start the game with the camouflaged look
  • There might be a few bugs, since I focused on getting the update out fast. A new version resolving the bugs will be published tomorrow.

Changes in v1.1:

  • Morphling: The color of pet now also morphs. The skin animation now starts at the right point.
  • The game over screen now shows if the Jester/Child/Lovers won.
  • A bug was removed where the Jester won together with the Crewmates.
  • A bug was removed where the game of the Lovers crashed if they were the last players killed by the host of the lobby.

Installation

Windows Auto Installation/Updating Using The AmongUsModUpdater

This tool was made by Narua and Jolle. It automatically installs/updates the TheOtherRoles mod to the newest version, runs the game and syncs your game options automatically.

  1. Simply get the newest release of the AmongUsModUpdater
  2. Unzip the folder and run the setup.exe

If you have problems with the AmongUsModUpdater, make sure To contact us.

Windows Manual Installation

  1. Download and unzip the newest release
  2. Find the folder of your game, for Steam players you can right click in Steam, on the game, a menu will appear proposing you to go to the folders.
  3. Make a copy of your game, it's not obligatory but advised, put it where you want.
  4. Drag or extract the files from the zip into your game, at the .exe level.
  5. Run the game (the first launch might take a while)

Not working? You might want to install the dependency vc_redist

Install

Linux Manual

  1. Install Among Us via Steam
  2. Download newest release and extract it to ~/.steam/steam/steamapps/common/Among Us
  3. Enable winhttp.dll via the proton winecfg (https://bepinex.github.io/bepinex_docs/master/articles/advanced/steam_interop.html#protonwine)
  4. Launch the game via Steam

Custom Servers and 10+ Players

We always recommend you to play on custom servers rather than on the official ones. If you want to play with more than 10 players in one lobby, you're required to use a custom server. Credits for the original implementation that allowed 10+ player lobbies go to the creaters of the Crowded-Mod.

Setup the Clients:

  1. Open the region menu where you can choose between the different regions
  2. Select the region Custom
  3. Enter the ip/domain and the port of your custom server in the corresponding text fields

Setup the Server:

  1. Get the Impostor release for the Among Us version 2021.3.31 - 2021.4.2
  2. Follow the steps (using the server release you just downloaded) on the official Impostor-Documentation
  3. Make sure to set the following values to false in the config.json file:
    ...
    "AntiCheat": {
      "Enabled": false,
      "BanIpFromGame": false
    }
  1. Make sure to forward the right ports on the hosting machine
  2. Run the server and setup the client

Setting up Server as Docker Container:
If you want to run the server as a docker container you'll need to use the image

aeonlucid/impostor:nightly

(Currently only the "nightly" tag is starting a server supporting 2021.3.31 or later)

In addition to running it we need to set the environment variables to disable the AntiCheat feature.

IMPOSTOR_AntiCheat__Enabled=false
IMPOSTOR_AntiCheat__BanIpFromGame=false

Example to docker run command:

docker run -p 22023:22023/udp --env IMPOSTOR_AntiCheat__Enabled=false --env IMPOSTOR_AntiCheat__BanIpFromGame=false aeonlucid/impostor:nightly

Or use to run it in the background

docker run -d -p 22023:22023/udp --env IMPOSTOR_AntiCheat__Enabled=false --env IMPOSTOR_AntiCheat__BanIpFromGame=false aeonlucid/impostor:nightly

Credits & Resources

OxygenFilter - For all versions above v2.3.0, we're using the OxygenFilter for automatic deobfuscation
Reactor - The framework used for all version before v2.0.0
BepInEx - Used to hook game functions
Essentials - Custom game options by DorCoMaNdO:

  • Before v1.6: We used the default Essentials release
  • v1.6-v1.8: We slightly changed the default Essentials. The changes can be found on this branch of our fork.
  • v2.0.0 and later: As we're not using Reactor anymore, we are using our own implementation, inspired by the one from DorCoMaNdO

Jackal and Sidekick - Original idea for the Jackal and Sidekick comes from Dhalucard
Among-Us-Love-Couple-Mod - Idea for the Lovers role comes from Woodi-dev
Jester - Idea for the Jester role comes from Maartii
ExtraRolesAmongUs - Idea for the Engineer and Medic role comes from NotHunter101. Also some code snippets come of the implementation were used.
Among-Us-Sheriff-Mod - Idea for the Sheriff role comes from Woodi-dev
TooManyRolesMods - Idea for the Detective and Time Master roles comes from Hardel-DW. Also some code snippets of the implementation were used.
TownOfUs - Idea for the Swapper, Shifter and a similar Mayor role come from Slushiegoose
Ottomated - Idea for the Morphling, Snitch and Camouflager role come from Ottomated
Crowded-Mod - Our implementation for 10+ player lobbies is inspired by the one from the Crowded Mod Team

Settings

The mod adds a few new settings to Among Us (in addition to the role settings):

  • Streamer Mode: You can activate the streamer mode in the Among Us settings. It hides the lobby code, the custom server ip and the custom server port. You can set a custom lobby code replacement text, by changing the Streamer Mode Replacement Text in the BepInEx\config\me.eisbison.theotherroles.cfg file.
  • Number of Impostors: The number of Impostor count be set inside a lobby
  • Map: The map can be changed inside a lobby
  • Maximum Number Of Meetings: You can set the maximum number of meetings that can be called in total (every player still has personal maximum of buttons, but if the maximum number of meetings is reached you can't use your meetings even if you have some left, Impostor and Jackal meetings also count)
  • Allow Skips On Emergency Meetings: If set to false, there will not be a skip button in emergency meetings. If a player does not vote, he'll vote himself.
  • Hide Player Names: Hides the names of all players that have role which is unknown to you. Team Lovers/Impostors/Jackal still see the names of their teammates. Impostors can alse see the name of the Spy and everyone can still see the age of the child.
  • Ghosts Can See Roles And Remaining Tasks: If set to true, ghosts can see the role and the number of remaining tasks of each player.

Custom Hats

Create and submit new hat designs

We're awaiting your creative hat designs and we'll integrate all the good ones in our mod. Here are a few instructions, on how to create a custom hat:

  • Creation: A hat consists of up to three textures. The aspect ratio of the textures has to be 4:5, we recommend 300px:375px:

    • Main texture (required):
      • This is the main texture of your hat. It will usually be rendered in front of the player, if you set the behind parameter it will be rendered behind the player.
      • The name of the texture needs to follow the pattern hatname.png, but you can also set some additional parameters in the file name by adding _parametername to the file name (before the .png).
      • Parameter bounce: This parameter determines whether the hat will bounce while you're walking or not.
      • Parameter adaptive: If this parameter is set, the Among Us coloring shader will be applied (the shader that replaces some colors with the colors that your character is wearing in the game). The color red (#ff0000) will be replaced with the primary color of your player and the color blue (#0000ff) with the secondary color. Also other colors will be affected and changed, you can have a look at the texture of the Crewmate Hat to see how this feature should be used.
      • Parameter behind: If this parameter is set, the main texture will be rendered behind the player.
    • Back texture (optional):
      • This texture will be rendered behind the player.
      • The name of the texture needs to follow the pattern hatname_back.png.
    • Climb texture (optional):
      • This texture will be rendered in front of the player, when he's climbing.
      • The name of the texture needs to follow the pattern hatname_climb.png.
  • Testing: You can test your hat design by putting all the files in the \TheOtherHats\Test subfolder of your mod folder. Then whenever you start a freeplay game, you and all the dummies will be wearing the new hat. You don't need to restart Among Us if you change the hat files, just exit and reenter the freeplay mode.

  • Submission: If you got a hat design, you can submit it on our Discord server. We'll look at all the hats and add all the good ones to the game.

Colors

drawing

Roles

Role Assignment

We are still improving the role assignment system. It's not that intuitive right now, but it's more flexible than the older one if you're using it right.

First you need to choose how many special roles you want in the game (one option for Impostor roles and one option for the rest). The count you set will only be reached, if there are enough Crewmates/Impostors in the game and if enough roles are set to be in the game (i.e. they are set to > 0%). The roles are then being distributed as follows:

  • First all roles that are set to 100% are being assigned to arbitrary players
  • After that each role that has 10%-90% selected adds 1-9 tickets to a ticket pool (one pool for Impostors, one for Crewmates). Then the roles will be selected randomly from that pool as long as possible (until the selected number is reached, until there are no more Crewmates or until there are no more tickets). If a role is selected from the pool, obviously all the tickets of that role are being removed.

Example:
Settings: 2 special Crewmate roles, Snitch: 100%, Hacker: 10%, Tracker: 30%
Result: Snitch is assigned, then one role out of the pool [Hacker, Tracker, Tracker, Tracker] is being selected
Note: Changing the settings to Hacker: 20%, Tracker: 60% would statistically result in the same outcome .

Mafia

Team: Impostors

The Mafia are a group of three Impostors.
The Godfather works like a normal Impostor.
The Mafioso is an Impostor who cannot kill nor sabotage until the Godfather is dead.
The Janitor is an Impostor who cannot kill nor sabotage, but they can hide dead bodies instead.

NOTE:

  • There have to be 3 Impostors activated for the mafia to spawn.

Game Options

Name Description
Mafia Spawn Chance -
Janitor Cooldown -

Morphling

Team: Impostors

The Morphling is an Impostor which can additionally scan the appearance of a player. After an arbitrary time they can take on that appearance for 10s.
NOTE:

  • They shrink to the size of the Child when they copies its look.
  • The Hacker sees the new color on the admin table.
  • The color of the footprints changes accordingly (also the ones that were already on the ground).
  • The other Impostor still sees that they are an Impostor (the name remains red).
  • The shield indicator changes accordingly (the Morphling gains or loses the shield indicator)
  • Tracker and Snitch arrows keep working.

Game Options

Name Description
Morphling Spawn Chance -
Morphling Cooldown -
Morph Duration Time the Morphling stays morphed

Camouflager

Team: Impostors

The Camouflager is an Impostor which can additionally activate a camouflage mode. The camouflage mode lasts for 10s and while it is active, all player names/pets/hats are hidden and all players have the same color.

NOTE

  • The Child will look like all the other players
  • The color of the footprints turns gray (also the ones that were already on the ground).
  • The Hacker sees gray icons on the admin table
  • The shield is not visible anymore
  • Tracker and Snitch arrows keep working

Game Options

Name Description
Camouflager Spawn Chance -
Camouflager Cooldown -
Camo Duration Time players stay camouflaged

Vampire

Team: Impostors

The Vampire is an Impostor, that can bite other player. Bitten players die after a configurable amount of time.
If the Vampire spawn chance is greater 0 (even if there is no Vampire in the game), all players can place one garlic.
If a victim is near a garlic, the "Bite Button" turns into the default "Kill Button" and the Vampire can only perform a normal kill.

NOTE:

  • If a bitten player is still alive when a meeting is being called, he dies at the start of the meeting.
  • The cooldown is the same as the default kill cooldown (+ the kill delay if the Vampire bites the target).
  • If there is a Vampire in the game, there can't be a Warlock

Game Options

Name Description
Vampire Spawn Chance -
Vampire Kill Delay -
Vampire Cooldown Sets the kill/bite cooldown
Vampire Can Kill Near Garlics The Vampire can never bite when his victim is near a garlic. If this option is set to true, he can still perform a normal kill there.

Eraser

Team: Impostors

The Eraser is an Impostor that can erase the role of every player.
The targeted players will lose their role after the meeting right before a player is exiled.
After every erase, the cooldown increases by 10 seconds.
The erase will be performed, even if the Eraser or his target die before the next meeting.
By default the Eraser can erase everyone but the Spy and other Impostors. Depending on the options he can also erase them (Impostors will lose their special Impostor ability).
NOTE:

  • The Shifter shift will always be triggered before the Erase (hence either the new role of the Shifter will be erased or the Shifter saves the role of his target, depending on who the Eraser erased)
  • Erasing a Lover automatically erases the other Lover as well (if the second Lover is an ImpLover, he will turn into an Impostor)
  • Erasing a Jackal that has a Sidekick, triggers the Sidekick promotion if it's activated in the settings
  • As the erasing is being triggered before the eject of a player, erasing and voting out a Lover in the same round, would result in the ex Lover surviving as the partnership was erased before. Also a Jester win would not happen, as the erase will be triggered before.

Game Options

Name Description
Eraser Spawn Chance -
Eraser Cooldown The Erasers cooldown will increase by 10 seconds after every erase.
Eraser Can Erase Anyone If set to false, he can't erase the Spy and other Impostors

Trickster

Team: Impostors

The Trickster is an Impostor that can place 3 jack-in-the-boxes that are invisible at first to other players.
If the Trickster has placed all of his boxes they will be converted into a vent network usable only by the Trickster himself, but the boxes are revealed to the others.
If the boxes are converted to a vent network, the Trickster gains a new ability "Lights out" to limit the visibility of Non-Impostors, that cannot be fixed by other players. Lights are automatically restored after a while. \


NOTE:

  • Impostors will get a text indicator at the bottom of the screen to notify them if the lights are out due to the Trickster ability, as there is no sabotage arrows or task to sabotage text to otherwise notify them about it.

Game Options

Name Description
Trickster Spawn Chance -
Trickster Box Cooldown Cooldown for placing jack-in-the-boxes
Trickster Lights Out Cooldown Cooldown for his "lights out" ability
Trickster Lights Out Duration Duration after which the light is automatically restored

Cleaner

Team: Impostors

The Cleaner is an Impostor who has the ability to clean up dead bodies. \


NOTE:

  • The Kill and Clean cooldown are shared, preventing him from immediately cleaning his own kills.

Game Options

Name Description
Cleaner Spawn Chance -
Cleaner Cooldown Cooldown for cleaning dead bodies

Warlock

Team: Impostors

The Warlock is an Impostor, that can curse another player (the cursed player doesn't get notified).
If the cursed person stands next to another player, the Warlock is able to kill that player (no matter how far away he is).
Performing a kill with the help of a cursed player, will lift the curse and it will result in the Warlock being unable to move for a configurable amount of time. The Warlock can still perform normal kills, but the two buttons share the same cooldown.


NOTE:

  • The Warlock can always kill his Impostor mates (and even himselfs) using the "cursed kill"
  • If there is a Warlock in the game, there can't be a Vampire
  • Performing a normal kill, doesn't lift the curse

Game Options

Name Description
Warlock Spawn Chance -
Warlock Cooldown Cooldown for using the Curse and curse Kill
Warlock Root Time Time the Warlock is rooted in place after killing using the curse

Lovers

Team: Either Crewmates or Impostors

There are always two Lovers which are linked together.
Their goal is it to stay alive together until the end of the game.
If one Lover dies (and the option is activated), the other Lover suicides.
You can specify the chance of one Lover being an Impostor.
The Lovers never know the role of their partner, they only see who their partner is.
The Lovers win if they are both alive among the last 3 players, however they can also win with their respective role.
If both Lovers are Crewmates, they can achieve a "double victory" but the Crewmates then also win.
If one Lover is an Impostor and one a Crewmate, they can only get a "Lovers solo win" where only they win (even if there is another Impostor alive).

NOTE:

  • If there is an equal amount of Impostors and Crewmates left in the game and one of the Lovers is an Impostor, the game is not automatically over since the Lovers can still achieve a solo win. E.g. if there are the following roles Impostor + ImpLover + Lover + Crewmate left, the game will not end and the next kill will decide if the Impostors or Lovers win.
  • The Lovers can change if the Shifter takes the role of a Lovers

Game Options

Name Description
Lovers Spawn Chance -
Chance That One Lover Is Impostor -
Both Lovers Die Whether the second Lover suicides, if the first one dies

Sheriff

Team: Crewmates

The Sheriff has the ability to kill Impostors. If they try to kill a Crewmate, they die instead.

NOTE

  • If the Sheriff shoots the person the Medic shielded, the Sheriff and the shielded person both remain unharmed.
  • If the Sheriff shoots a Child Impostor, the Sheriff dies if the Child is still growing up. If it's 18, the Child Impostor dies.

Game Options

Name Description
Sheriff Spawn Chance -
Sheriff Cooldown -
Jester Can Die To Sheriff -

Jester

Team: Neutral

The Jester does not have any tasks. They win the game as a solo, if they get voted out during a meeting.

Game Options

Name Description
Jester Spawn Chance -
Jester can call emergency meeting Option to disable the emergency button for the Jester

Seer

Team: Crewmates

The Seer has two abilities (one can activate one of them or both in the options). The Seer sees the souls of players that died a round earlier, the souls slowy fade away. The Seer gets a blue flash on his screen, if a player dies somewhere on the map.

Game Options

Name Description
Seer Spawn Chance -
Seer Mode Options: Show death flash and souls, show death flash, show souls
Seer Limit Soul Duration Toggle if souls should turn invisible after a while
Seer Soul Duration Sets how long it will take the souls to turn invisible after a meeting

Engineer

Team: Crewmates

The Engineer (if alive) can fix one sabotage per game from anywhere on the map.
The Engineer can use vents. If the Engineer is inside a vent, the Impostors will see a blue outline around all vents on the map (in order to warn them). Because of the vents the Engineer might not be able to start some tasks using the "Use" button, you can double click on the tasks instead.
NOTE:

  • The kill button of Impostors activates if they stand next to a vent where the Engineer is. They can also kill them there. No other action (e.g. Morphling sample, Shifter shift, ...) can affect players inside vents.

Game Options

Name Description
Engineer Spawn Chance -

Detective

Team: Crewmates

The Detective can see footprints that other players leave behind. The Detective's other feature shows when they report a corpse: they recieve clues about the killer's identity. The type of information they get is based on the time it took them to find the corpse.
NOTE

  • When people change their colors (because of a morph or camouflage), all the footprints also change their colors (also the ones that were already on the ground). If the effects are over, all footprints switch back to the original color.
  • The Detective does not see footprints of players that sit in vents
  • More information about the colors

Game Options

Name Description
Detective Spawn Chance -
Anonymous Footprints If set to true, all footprints will have the same color. Otherwise they will have the color of the respective player.
Footprint Intervall The intervall between two footprints
Footprint Duration Sets how long the footprints remain visible.
Time Where Detective Reports Will Have Name The amount of time that the Detective will have to report the body since death to get the killer's name.
Time Where Detective Reports Will Have Color Type The amount of time that the Detective will have to report the body since death to get the killer's color type.

Lighter

Team: Crewmates

The Lighter can turn on his Lighter every now and then, which increases his vision by a costumizable amount.

Game Options

Name Description
Lighter Spawn Chance -
Lighter Mode Vision On Lights On The vision the Lighter has when the lights are on and the Lighter mode is on
Lighter Mode Vision On Lights Off The vision the Lighter has when the lights are down and the Lighter mode is on
Lighter Cooldown -
Lighter Duration -

Child

Team: Crewmates or Impostors

The Child can be a Crewmate (67% chance) or an Impostor (33% chance).
The Child's character is smaller and hence visible to everyone in the game.
The Child cannot be killed until it turns 18 years old, however it can be voted out.
Impostor Child:

  • While growing up the kill cooldown is doubled. When it's fully grown up its kill cooldown is 2/3 of the default one.
  • If it gets thrown out of the ship, everything is fine.

Crewmate Child:

  • The Crewmate Child aims to play out the strength its invincibility in the early game.
  • If it gets thrown out of the ship before it turns 18, everyone loses. So think twice before you vote out a Child.

NOTE:

  • Impostors can't kill the Child (the button does not work) until it turns 18
  • The Sheriff can kill the Impostor Child, but only if it's fully grown up

Game Options

Name Description
Child Spawn Chance -
Child Child Growing Up Duration

Medic

Team: Crewmates

The Medic can shield (highlighted by an outline around the player) one player per game, which makes the player unkillable.
The shielded player can still be voted out and might also be an Impostor.
If set in the options, the shielded player will get a red flash on their screen if someone (Impostor, Sheriff, ...) tried to murder them. If the Medic dies, the shield disappears with them.
The Sheriff will not die if they try to kill a shielded Crewmate and won't perform a kill if they try to kill a shielded Impostor.
The Medic's other feature shows when they report a corpse: they will see how long ago the player died
NOTE

  • If the shielded player is a Lover and the other Lover dies, they nevertheless kill themselves.
  • If the Shifter has a shield or their target has a Shield, the shielded player switches.

Game Options

Name Description Options
Medic Spawn Chance - -
Show Shielded Player Sets who sees if a player has a shield "Everyone", "Shielded + Medic", "Medic"
Shielded Player Sees Murder Attempt Whether a shielded player sees if someone tries to kill him True/false

Mayor

Team: Crewmates

The Mayor leades the Crewmates by having a vote that counts twice.
The Mayor can always use his meeting, even if the maximum number of meetings was reached.

Game Options

Name Description
Mayor Spawn Chance -

Hacker

Team: Crewmates

If the Hacker activates the "Hacker mode", the Hacker gets more information than others from the admin table and vitals for a set duration.
Otherwise he sees the same information as everyone else. Admin table: The Hacker can see the colors (or color types) of the players on the table.
Vitals: The Hacker can see how long dead players have been dead for.

NOTE:

  • If the Morphling morphes or the Camouflager camouflages, the colors on the admin table change accordingly
  • More information about the colors

Game Options

Name Description
Hacker Spawn Chance -
Hacker Cooldown -
Hacker Duration Sets how long the "Hacker mode" remains active
Hacker Only Sees Color Type Sets if the Hacker sees the player colors on the admin table or only white/gray (for Lighter and darker colors)

Shifter

Team: Crewmates

The Shifter can take over the role of another Crewmate or Neutral, the other player will transform into a Crewmate.
The Shift will always be performed at the end of the next meeting right before a player is exiled. The target needs to be chosen during the round.
Even if the Shifter or the target dies before the meeting, the Shift will still be performed.
Swapping roles with a Crewmate or Neutral gives them their role, the other player becomes a Crewmate.
Swapping roles with an Impostor or a custom Impostor role fails and the Shifter commits suicide after the next meeting (there won't be any body).
The Shifter aims to save roles from leaving the game, by e.g. taking over a Sheriff or Medic that is known to the Impostors.
This works especially well against the Eraser, but also gives the Eraser the possiblity to act like a Shifter.
The special interactions with the Shifter are noted in the chapters of the respective roles.

NOTE:

  • The Shifter shift will always be triggered before the Erase (hence either the new role of the Shifter will be erased or the Shifter saves the role of his target, depending on who the Eraser erased)
  • If the Shifter takes over a role, their new cooldowns will start at the maximum cooldown of the ability
  • One time use abilities (e.g. shielding a player or Engineer sabotage fix) can only used by one player in the game (i.e. the Shifter can only use them, if the previous player did not used them before)

Game Options

Name Description
Shifter Spawn Chance -

Time Master

Team: Crewmates

The Time Master has a time shield which he can activate. The time shield remains active for a configurable amount of time.
If a player trys to kill the Time Master while the time shield is active, the kill won't happen and the time will rewind for a set amount of time.
The kill cooldown of the killer won't be reset, so the Time Master has to make sure that the game won't result in the same situation.
The Time Master won't be affected by the rewind.

NOTE:

  • Only the movement is affected by the rewind
  • A Vampire bite will trigger the rewind. If the Time Master misses shielding the bite, he can still shield the kill which happens a few seconds later.
  • If the Time Master was bitten and has his shield active before when a meeting is called, he survives but the time won't be rewinded.
  • If the Time Master has a Medic shield, he won't rewind.
  • The shield itself ends immediately when triggered. So the timemaster can be attacked again as soon as the rewind ends.

Game Options

Name Description
Time Master Spawn Chance -
Time Master Cooldown -
Rewind Duration How much time to rewind
Time Master Shield Duration

Swapper

Team: Crewmates

During meetings the Swapper can exchange votes that two people get (i.e. all votes that player A got will be given to player B and vice versa).
Because of the Swappers strength in meetings, they might not start emergency meetings and can't fix lights and comms.

Game Options

Name Description
Swapper Spawn Chance -
Swapper can call emergency meeting Option to disable the emergency button for the Swapper

Tracker

Team: Crewmates

The Tracker can select one player in a game and tracks this player for the rest of the game. An arrow points to the last tracked position of the player. The arrow updates it's position every few seconds (configurable).

Game Options

Name Description
Tracker Spawn Chance -
Tracker Update Intervall Sets how often the position is being updated

Snitch

Team: Crewmates

When the Snitch finishes all the tasks, arrows will appear (only visible to the Snitch) that point to the Impostors. When the Snitch has one task left (configurable) the Snitch will be revealed to the Impostors, also with an arrow.

Game Options

Name Description
Snitch Spawn Chance -
Task Count Where Impostors See Snitch -

Jackal

Team: Jackal

The Jackal is part of an extra team, that tries to eliminate all the other players.
The Jackal has no tasks and can kill Impostors, Crewmates and Neutrals.
The Jackal (if allowed by the options) can select another player to be his Sidekick. Creating a Sidekick removes all tasks of the Sidekick and adds him to the team Jackal. The Sidekick loses his current role (except if he's a Lover, then he plays in two teams). The "Create Sidekick Action" may only be used once per Jackal or once per game (depending on the options). The Jackal can also promote Impostors to be his Sidekick, but depending on the options the Impostor will either really turn into the Sidekick and leave the team Impostors or he will just look like the Sidekick to the Jackal an remain as he was.

The team Jackal enables multiple new outcomes of the game, listing some examples here:

  • The Impostors could be eliminated and then the crew plays against the team Jackal.
  • The Crew could be eliminated, then the Team Jackal fight against the Impostors (the Crew can still make a task win in this scenario)

The priority of the win conditions is the following:

  1. Crewmate Child lose by vote
  2. Jester wins by vote
  3. Team Impostor wins by sabotage
  4. Team Crew wins by tasks (also possible if the whole Crew is dead)
  5. Lovers among the last three players win
  6. Team Jackal wins by outnumbering (When the team Jackal contains an equal or greater amount of players than the Crew and there are 0 Impostors left and team Jackal contains no Lover)
  7. Team Impostor wins by outnumbering (When the team Impostors contains an equal or greater amount of players than the Crew and there are 0 players of the team Jackal left and team Impostors contains no Lover)
  8. Team Crew wins by outnumbering (When there is no player of the team Jackal and the team Impostrs left)

NOTE:

  • The Jackal (and his Sidekick) may be killed by a Sheriff.
  • A Jackal cannot target the Child, while it's growing up. After that he can kill it or select it as its Sidekick
  • The Crew can still win, even if all of their members are dead, if they finish their tasks fast enough (that's why converting the last Crewmate with tasks left into a Sidekick results in a task win for the crew)

If both Impostors and Jackals are in the game the game continues even if all Crewmates are dead. Crewmates may still win in this case by completing their tasks. Jackal and Impostor have to kill each other.

Game Options

Name Description
Jackal Spawn Chance -
Jackal/Sidekick Kill Cooldown Kill cooldown
Jackal Create Sidekick Cooldown Cooldown before a Sidekick can be created
Jackal can use vents Yes/No
Jackal can create a Sidekick Yes/No
Jackals promoted from Sidekick can create a Sidekick Yes/No (to prevent the Jackal team from growing)
Jackals can make an Impostor to his Sidekick Yes/No (to prevent a Jackal from turning an Impostor into a Sidekick, if he uses the ability on an Impostor he sees the Impostor as Sidekick, but the Impostor isn't converted to Sidekick. If this option is set to "No" Jackal and Sidekick can kill each other )

Sidekick

Team: Jackal

Gets assigned to a player during the game by the "Create Sidekick Action" of the Jackal and joins the Jackal in his quest to eliminate all other players.
Upon the death of the Jackal (depending on the options), he might get promoted to Jackal himself and potentially even assign a Sidekick of his own.
NOTE:

  • A player that converts into a Sidekick loses his previous role and tasks (if he had one), except the Lover role.
  • The Sidekick may be killed by a Sheriff.
  • The Sidekick cannot target the Child, while it's growing up.

Game Options

Name Description
Jackal/Sidekick Kill Cooldown Uses the same kill cooldown setting as the Jackal
Sidekick gets promoted to Jackal on Jackal death Yes/No
Sidekick can kill Yes/No
Sidekick can use vents Yes/No

Spy

Team: Crewmates

The Spy is a Crewmate, which has no special abilities.
The Spy looks like an additional Impostor to the Impostors, they can't tell the difference.
There are two possibilities (depending on the set options):

  • The Impostors can't kill the Spy (because otherwise their kill button would reveal, who the Spy is)
  • The Impostors can kill the Spy but they can also kill their Impostor partner (if they mistake another Impostor for the Spy) You can set whether the Sheriff can kill the Spy or not (in order to keep the lie alive).

Game Options

Name Description
Spy Spawn Chance
Spy Can Die To Sheriff
Impostors Can Kill Anyone If There Is A Spy This allows the Impostors to kill both the Spy and their Impostor partners

Security Guard

Team: Crewmates

The Security Guard is a Crewmate that has a certain amount of screws that he can use for either sealing vents or for placing new cameras.
Placing a new camera and sealing vents takes a configurable amount of screws. The total number of screws that a SecurityGuard has can also be configured.
The new camera will be visible after the next meeting and accessible by everyone.
The vents will be sealed after the next meeting, players can't enter or exit sealed vents, but they can still "move to them" underground.
NOTE:

  • Tickster boxes can't be sealed
  • The remaining number of screws can be seen above his special button
  • On Skeld the four cameras will be replaced every 3 seconds (with the next four cameras). You can also navigate manually using the arrow keys.

Game Options

Name Description
Security Guard Spawn Chance
Security Guard Cooldown
Security Guard Number Of Screws The number of screws that a Security Guard can use in a game
Number Of Screws Per Cam The number of screws it takes to place a camera
Number Of Screws Per Vent The number of screws it takes to seal a vent

Source code

It's bad I know, this is a side project and my second week of modding. So there are no best practices around here. You can use parts of the code but don't copy paste the whole thing. Make sure you give credits to the other developers, because some parts of the code are based on theirs.

Bugs, suggestions and requests

If you found any bugs, have an idea for a new role or any other request, join our Discord server