Skip to content

Commit

Permalink
clean up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
minhd-vu committed Feb 27, 2024
1 parent 16ca42f commit ac5c135
Showing 1 changed file with 4 additions and 61 deletions.
65 changes: 4 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,6 @@
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [How to Play](#how-to-play)
- [Create a User](#create-a-user)
- [Party System](#party-system)
- [Join a Party](#join-a-party)
- [Create a Party](#create-a-party)
- [Leave a Party](#leave-a-party)
- [Start a Party](#start-a-party)
- [Eliminate Targets](#eliminate-targets)
- [Game Modes](#game-modes)
- [Classic](#classic)
- [Shuffle](#shuffle)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
Expand All @@ -49,6 +39,10 @@ This project is designed to easily facilitate the distribution of targets to pla
- [Next.js](https://nextjs.org/)
- [MongoDB](https://www.mongodb.com/)

### How to Play

Head over to https://assassinspartygame.vercel.app/help to learn how to play.

<!-- GETTING STARTED -->

## Getting Started
Expand Down Expand Up @@ -85,57 +79,6 @@ npm run dev
npm start
```

## How to Play

Assassins is a live action game that can be played almost anywhere, but best done in semi-crowded environments. The goal of the game is to be the last remaining person alive and to assassinate whomever you are assigned.

#### Create a User

Before doing anything, you should create a user. It will keep track of your statistics as well as identifying who you are in a party. You can register yourself by heading to the register link in the navbar. Once you create a user, you will no longer be able to change the username or password.

If you already have a user, you can login by heading to the login link in the navbar.

#### Party System

![lobby](docs/lobby.png?raw=true "Party Lobby")

Once you have logged in you have the option of joining or creating a party. A party is an instance of the assassins game; it is how you connect with your friends.

##### Join a Party

To join a party, type in the party code in the input field on the <Link to="/">home page</Link> then click the **Join Party** button. Once a party has started you can no longer join it.

##### Create a Party

To create a party, click the **Create Party** button on the home page. Once you have created it, the app will display the party code in bold. Give this code to your friends so that they can join.

##### Leave a Party

Once you join a party, you have the option of leaving it. You can leave it anytime, and the app will handle the reshuffling of players.

##### Start a Party

Only the party leader can start the party. Once started everyone is assigned a target.

#### Eliminate Targets

![lobby-started](docs/lobby-started.png?raw=true "Lobby Started")
![leaderboard](docs/leaderboard.png?raw=true "Leaderboard")

You will be assigned a target to assassinate, hence the name _assassins_. Once you assassinated your target, either by means of dart blasters, tag, projectile launchers, or any other method, click the **Assassinate** button.

A notification will be send to the target just eliminated, the target will have option of confirming or denying the assassination attempt. If the attempt is denied, the game continues; this is in place to prevent accidental clicks. If the attempt is successful, you will be assigned a new target depending on the game mode.

#### Game Modes

##### Classic

When you assassinate a target, your next target will be the target your target had.

##### Shuffle

When a player assassinates a target, all players will receive a new target from the remaining players alive.

## Acknowledgements

- [Minh Vu](https://github.com/minhd-vu)
Expand Down

0 comments on commit ac5c135

Please sign in to comment.