Add files via upload

README.md

@@ -0,0 +1,338 @@
+[![Discord](https://discord.com/assets/e4923594e694a21542a489471ecffa50.svg)](https://discord.gg/77RkMJHWsM)
+![eisbison banner](./Banner.png)
+![eisbison infographic](./Preview.png)
+
+
+# The Other Roles
+
+The **The Other Roles**, is a mod for Amongs Us which currently adds 20 additional roles to the game.
+Even more roles are coming soon :)
+
+- [Mafia](#mafia)
+  - Godfather
+  - Janitor
+  - Mafioso
+- [Morphling](#morphling)
+- [Camouflager](#camouflager)
+- [Lovers](#lovers)
+  - Lover
+  - ImpLover
+- [Sheriff](#sheriff)
+- [Jester](#jester)
+- [Seer](#seer)
+- [Engineer](#engineer)
+- [Detective](#detective)
+- [Lighter](#lighter)
+- [Child](#child)
+- [Medic](#medic)
+- [Mayor](#mayor)
+- [Spy](#spy)
+- [Shifter](#shifter)
+- [Time Master](#time%20master)
+- [Swapper](#swapper)
+
+
+# Releases :
+| Among Us - Version| Mod Version | Link |
+|----------|-------------|-----------------|
+| 2020.12.19s | v1.0 | [Download](https://github.com/Eisbison/TheOtherRoles/files/6097191/TheOtherRoles.zip) |
+
+# Installation 
+**Note: No private server is required, you can play on the official servers.**  
+1. Download and unzip the newest [release](https://github.com/Eisbison/TheOtherRoles/files/6097191/TheOtherRoles.zip)
+2. Find the folder of your game, for steams 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 advise, put it where you want.
+4. Drag or extract the files from the zip into your game, at the .exe level.
+6. Run the game (the first launch might take a while)
+
+Not working? You might want to install the dependency [vc_redist](https://aka.ms/vs/16/release/vc_redist.x86.exe)
+
+![Install](https://i.imgur.com/pvBAyZN.png)
+
+# Roles
+
+## 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 he 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 he can take on that appearance for 10s.
+\
+**NOTE**
+- He shrinks to the size of the child when he copies its look.
+- The color of the footprints does **not** change.
+- The Seer still sees the Morphlings role if he revealed it.
+- The other impostor still sees that he is an impostor (the name remains red).
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Morphling Spawn Chance | -
+| Morphling Cooldown | -
+-----------------------
+
+## 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 and Morphling when copying the child remain small.
+- The color of the footprints does **not** change.
+- The Seer still sees all the roles he revealed.
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Camouflager Spawn Chance | -
+| Camouflager Cooldown | -
+-----------------------
+
+## 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.\
+There is a 67% chance that both Lovers are crewmates and a 33% chance that one of them is an impostor (ImpLover) and one a crewmate. In both cases they don't see the role of the other player, they only see that they are a Lover\
+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 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 exchanges role with one of the Lovers
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Lovers Spawn Chance | -
+| 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 he tries to kill a crewmate, he dies instead.
+
+**NOTE**
+- For now the Shifter won't die to the Sheriff (an option will be added in the next version).
+- If the Sheriff shoots the person the Medic shielded, the Sheriff and the shielded person **both remain unharmed**.
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Sheriff Spawn Chance | -
+| Sheriff Cooldown | -
+| Jester Can Die To Sheriff | -
+-----------------------
+
+## Jester
+### **Team: Neutral**
+The Jester does not have any tasks. He wins the game as a solo, if he gets voted out during a meeting.
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Jester Spawn Chance | -
+-----------------------
+
+## Seer
+### **Team: Crewmates**
+The Seer has the ability to find out about people's intentions. The information is only visible to himself.\
+Depending on the selected option he either directly sees the role of the player (appended to his name) or if the player is 
+a good (name text changes to yellow) or a bad (name text changes to a darker color) player.\
+Depending on the selected option the player will get a blue flash on his screen if he is being revealed by the Seer.
+\
+**NOTE**
+- **Good players:** Crewmates with all their special roles\
+- **Bad players:** Impostors with all their special roles (Mafia, Morphling, Camouflager, ImpLover) and the neutral roles (Jester, Shifter)
+- **Cooldown:** The cooldown of the Seer wil **not** be reset after a meeting (in order to balance the option to reveal roles)
+- If the role of a revealed player changes during the game (because of e.g. the Shifter), the information of the Seers also adapts.
+- When the Camouflager camouflages all players or the Morphling copies the appearance of another player, the Seer still sees the information he gained earlier (i.e. he still sees that the player is the Morphling even if his appearance is different).
+- If the Shifter exchanges the role with the Seer the information gained by the Seer will be transfered to the new Seer (i.e. the new Seer sees what the old one revealed and the old one "loses" the information he gained).
+
+### Game Options
+| Name | Description | Options |
+|----------|:-------------:|:-------------:|
+| Seer Spawn Chance | - | -
+| Seer Cooldown | Cooldown for his special ability. This cooldown will **not** be reset after a meeting | -
+| Info That Seer Reveals | Description above | "Role", "Good/Bad"
+| Players That See When They Are Being Revealed | Selects the group of players that get notified when they are being revealed | "Everyone", "The Good", "The Bad", "Nobody"
+-----------------------
+
+## Engineer
+### **Team: Crewmates**
+The Engineer (if alive) can fix one sabotage per game from anywhere on the map.\
+The Engineer can use vents.
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Engineer Spawn Chance | -
+-----------------------
+
+## Detective
+### **Team: Crewmates**
+The Detective can see footprints that other players leave behind.
+\
+**NOTE**
+- Even when the Morphling changes his appearance or the Camouflager camouflages everyone, the
+Detective still sees the right (original) 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.
+-----------------------
+
+## Lighter
+### **Team: Crewmates**
+The vision of the Lighter never changes, even if the lights are out.\
+Depending on the options the Lighter can have a bigger or smaller vision than other crewmates.
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Lighter Spawn Chance | -
+| Lighter Vision | -
+-----------------------
+
+## Child
+### **Team: Crewmates**
+The Child won't be harmed by anyone, since if it dies everyone besides the child will lose the game.\
+The Child's character is smaller and hence visible to everyone in the game.\
+The child works with the crewmate and aims to play out the strength of its "invincibility".\
+It does **not** want to win the game as a dead child and the impostors **don't want** to deny
+a crewmate win by killing a child (changes will come to prevent this behaviour).
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Child Spawn Chance | -
+-----------------------
+
+## 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 his screen if someone (Impostor, Sheriff, ...) tried to murder him.
+If the Medic dies, the shield disappears with him.\
+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 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**
+- **Lighter Colors:** Pink, orange, yellow, white, cyan, lime
+- **Darker Colors:** Red, blue, green, grey, purple, brown
+- If the shielded player is a Lover and the other Lover dies, he nevertheless kills himself.
+- If the Shifter has a shield or his 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"
+| Time Where Medic Reports Will Have Name | The amount of time that the Medic will have to report the body since death to get the killer's name.  |
+| Time Where Medic Reports Will Have Color Type| The amount of time that the Medic will have to report the body since death to get the killer's color type. |
+|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.
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Mayor Spawn Chance | -
+-----------------------
+
+## Spy
+### **Team: Crewmates**
+The Spy gets more information than others from the admin table and vitals. \
+**Admin table:** The spy can see the colors of the players on the table.\
+**Vitals**: The spy can see how long dead players have been dead for.
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Spy Spawn Chance | -
+-----------------------
+
+
+## Shifter
+### **Team: Neutral**
+The Shifter belongs to no team and has no tasks.\
+The Shifter always loses the game, however they can exchange roles with other players.\
+Swapping roles with a crewmate or a custom crewmate role (or the Jester) gives them their role and their tasks, the other player becomes the new Shifter.\
+Swapping roles with an impostor or a custom impostor role fails and the Shifter commits suicide.\
+The **special interactions** with the Shifter are noted in the chapters of the respective roles.
+**NOTE:**
+- If the Shifter takes over a role, his 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 player they exchanged roles with have not used them before)
+
+### Game Options
+| Name | Description
+|----------|:-------------:|
+| Shifter Spawn Chance | -
+| Shifter Cooldown | -
+-----------------------
+
+## Time Master
+### **Team: Crewmates**
+The Time Master can rewind the time.\
+If set in the options, players will be revived during the time rewind.\
+Only movement and kills are affected (not cooldowns, meetings, tasks, ...)
+
+### Game Options
+| Name | Description |
+|----------|:-------------:|
+| Time Master Spawn Chance | - |
+| Time Master Cooldown | - |
+| Rewind Duration | How much time to rewind |
+| Revive During Rewind | Whether to revive dead players when rewinding |
+-----------------------
+
+## 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, he can't start emergency meetings
+and can't fix lights and comms.
+
+### Game Options
+| Name | Description
+|----------|:-------------:|
+| Swapper Spawn Chance | -
+-----------------------
+
+# Bugs, suggestions and requests
+If you found any bugs, have an idea for an idea for a new role or any other request, join my [Discord server](https://discord.gg/77RkMJHWsM)
+
+# Credits & Resources
+[Reactor](https://github.com/NuclearPowered/Reactor) - The framework used\
+[BepInEx](https://github.com/BepInEx) - Used to hook game functions\
+[Essentials](https://github.com/DorCoMaNdO/Reactor-Essentials) - Custom game options.\
+[Among-Us-Love-Couple-Mod](https://github.com/Woodi-dev/Among-Us-Love-Couple-Mod) - Lovers role.\
+[ExtraRolesAmongUs](https://github.com/NotHunter101/ExtraRolesAmongUs) - Engineer, Medic, Jester and Sheriff role.\
+[TooManyRolesMods](https://github.com/Hardel-DW/TooManyRolesMods) - Detective and Time Master roles.\
+[TownOfUs](https://github.com/slushiegoose/Town-Of-Us) - Inspiration for Swapper and Shifter roles.