Skip to content

Commit

Permalink
Make a README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ellie authored Jan 22, 2024
1 parent fed387c commit ee6e5df
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
# Fabric Example Mod
# Sabotage
Sabotage is a social deduction game similar to Murder Mystery or Trouble in Terrorist Town
It is split between 3 roles, each with their own goals and means of attack or defense:

## Setup
### Saboteur
The bad guy, they have to kill all of the [Innocents](#innocent) and [Detectives](#detective) without being revealed as a Saboteur.
Work with other Saboteurs to sneakily kill others without being caught and blend in with the crowd as to not seem suspicious.
Saboteurs can see everyone's roles, use this to your advantage. Target [Detectives](#detective) and get an increased reward.
Avoid each map's Tester and the [Detective's](#detective) Portable Tester, as that is used to find out a player's role.

For setup instructions please see the [fabric wiki page](https://fabricmc.net/wiki/tutorial:setup) that relates to the IDE that you are using.
### Detective
The Detective is a wild card to [Saboteurs](#saboteur) as they are equipped with a Portable Tester that can determine someone's role,
be careful using this though, as it has limited uses. [Innocents](#innocent) and [Saboteurs](#saboteur) both know who the Detectives are,
make sure to protect yourself or else you will be targetted.

## License
### Innocent
The Innocents work with [Detectives](#detective) to find out and kill all [Saboteurs](#saboteur).
Gain the trust of [Detectives](#detective), protect them and use your numbers to ambush and kill [Saboteurs](#saboteur)
Use each map's Tester to prove your innocence and to find [Saboteurs](#saboteur).

This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
---
Gear up by opening chests, share resources with trusted players, deduct player's roles through various means and win.

## Installation
This mod requires [Plasmid](https://modrinth.com/mod/plasmid), [Polymer](https://modrinth.com/mod/polymer) and [Fabric API](https://modrinth.com/mod/fabric-api) to work.
It is meant to be installed in a Server, installing it on a Client will likely work, but it is not tested and as such I do not recommend doing so.

0 comments on commit ee6e5df

Please sign in to comment.