Skip to content

Commit

Permalink
add help page
Browse files Browse the repository at this point in the history
  • Loading branch information
minhd-vu committed Feb 27, 2024
1 parent 0ca429e commit 16ca42f
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
81 changes: 81 additions & 0 deletions app/help/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
import Link from "next/link";

export default function Help() {
return (
<div className="prose mx-6">
<h2 id="how-to-play">How to Play</h2>
<p>
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.
</p>
<h4 id="create-a-user">Create a User</h4>
<p>
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.
</p>
<p>
If you already have a user, you can login by heading to the login link
in the navbar.
</p>
<h4 id="party-system">Party System</h4>
<p>
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.
</p>
<h5 id="join-a-party">Join a Party</h5>
<p>
To join a party, type in the party code in the input field on the{" "}
<Link href="/">home page</Link> then click the{" "}
<strong>Join Party</strong> button. Once a party has started you can no
longer join it.
</p>
<h5 id="create-a-party">Create a Party</h5>
<p>
To create a party, click the <strong>Create Party</strong> 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.
</p>
<h5 id="leave-a-party">Leave a Party</h5>
<p>
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.
</p>
<h5 id="start-a-party">Start a Party</h5>
<p>
Only the party leader can start the party. Once started everyone is
assigned a target.
</p>
<h4 id="eliminate-targets">Eliminate Targets</h4>
<p>
You will be assigned a target to assassinate, hence the name{" "}
<em>assassins</em>. Once you assassinated your target, either by means
of dart blasters, tag, projectile launchers, or any other method, click
the <strong>Assassinate</strong> button.
</p>
<p>
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.
</p>
<h4 id="game-modes">Game Modes</h4>
<h5 id="classic">Classic</h5>
<p>
When you assassinate a target, your next target will be the target your
target had.
</p>
<h5 id="shuffle">Shuffle</h5>
<p>
When a player assassinates a target, all players will receive a new
target from the remaining players alive.
</p>
</div>
);
}
3 changes: 3 additions & 0 deletions components/Navbar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ export default async function Navbar() {
<li>
<a href="/leaderboard">Leaderboard</a>
</li>
<li>
<a href="/help">Help</a>
</li>
<li>
<LoginButton />
</li>
Expand Down

0 comments on commit 16ca42f

Please sign in to comment.