Git_Mirror/Werewolf
1
0
Fork 0
mirror of https://github.com/AlecM33/Werewolf.git synced 2025-12-26 15:57:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
AlecM33
2022-05-12 12:21:16 -04:00
parent 067146474a
commit d37802fc9c
1 changed files with 15 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -19,29 +19,34 @@ Inspired by my time playing <a href="https://boardgamegeek.com/boardgame/152242/
## Features
You can:
- build your desired game with default or custom roles.
- join a game with two clicks via a shareable link, or via a 4-character code entered on the homepage.
- automatically deal cards to everyone's device.
- create a game as a "dedicated moderator", who is not dealt in, or as a "temporary moderator", who is dealt in and
then has their powers automatically delegated.
- transfer your mod powers to someone else that is out of the game if you can no longer mod.
- run a shared timer that can be paused by the moderator.
- reference helpful info during the game including what roles are in the game and who has been killed or revealed.
- choose to reveal a player without killing them, or kill them without revealing them.
- restart the same game setup any number of times
This is meant to facilitate a game through a shared game state and various utilities - not to control
every aspect of the game flow. The app provides a host the ability to construct a deck with a custom distribution
of roles. Players can join a game with one click and are then dealt a role to their device. The app features a concealable
role card, an optional shared timer (which the moderator can play/pause), a reference for roles in the game, and status
information for players including who is alive/dead and who has had their role revealed. The app also provides the
option for a "dedicated moderator" or a "temporary moderator." Dedicated moderators will never be dealt in, and will
have all controls and information from the beginning of the game. Temporary moderators _will_ be dealt a role and will
have some moderator powers, but will only exist until the first player is out, at which point that player will be made
the game's dedicated moderator. A dedicated moderator can transfer their powers to another player that is out of the
game at any time.
The application prioritizes responsiveness. A key scenario would be when a group is hanging out with only their phones.
## Tech Stack
This is a Node.js application. It is written purely using JavaScript/HTML/CSS. The index dependencies are
This is a Node.js application. It is written purely using JavaScript/HTML/CSS. The main dependencies are
<a href="https://expressjs.com/">Express.js</a> and <a href="https://socket.io/">Socket.io</a>. It is currently cloud hosted using the <a href='https://cloud.google.com/appengine'>Google App Engine</a>.
## Contributing and Developers' Guide
### Running Locally
The entrypoint for the application is in `index.js` at the root.
The entrypoint for the application is `index.js` at the root.
If you haven't already, install <a href="https://nodejs.org/en/">Node.js.</a> This should include the node package
manager, <a href="https://www.npmjs.com/">npm</a>.