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.md

Browse Source
This commit is contained in:
Alec
2022-02-23 22:05:59 -05:00
committed by GitHub
parent d717d58cc7
commit 6e5d1781a6
1 changed files with 7 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -3,15 +3,13 @@
</p>
Find the latest deployment here: https://playwerewolf.uk.r.appspot.com/.
I value your feedback.
An application to run games of <a href="https://en.wikipedia.org/wiki/Mafia_(party_game)">Werewolf (Mafia)</a>
smoothly when you don't have a deck, or when you and your friends are together virtually. Inspired by my time playing
<a href="https://boardgamegeek.com/boardgame/152242/ultimate-werewolf-deluxe-edition">Ultimate Werewolf</a> and by
2020's quarantine. The app is free to use and anonymous.
smoothly when you don't have a deck, or when you and your friends are together virtually. Basically, a host builds a game and deals a role to everyone's device, and then the app keeps track of the game state (timer, player statuses, etc).
Inspired by my time playing <a href="https://boardgamegeek.com/boardgame/152242/ultimate-werewolf-deluxe-edition">Ultimate Werewolf</a> and by
2020's quarantine. The app is free to use, anonymous, and fully open-source under the MIT license. After a long hiatus I've rewritten a lot of the code and think this version works a lot better. This was (and still is) fundamentally a learning project, so feedback or assistance is appreciated.
After a long hiatus from maintaining the application, I have come back and undertaken a large-scale redesign, rewriting
most of the code and producing a result that I believe is more stable and has much more sensible client-server interaction.
<br><br>
<p align="center">
<img width="600" src="./client/src/images/screenshots/player.PNG"/>
@@ -35,11 +33,7 @@ The application prioritizes responsiveness. A key scenario would be when a group
## Tech Stack
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 fully open-source
and under the MIT license. This was (and still is) fundamentally a learning project, and thus I welcome collaboration
and feedback of any kind.
All pixel art is my own, for better or for worse.
<a href="https://expressjs.com/">Express.js</a> and <a href="https://socket.io/">Socket.io</a>.
## Contributing and Developers' Guide
@@ -62,10 +56,10 @@ This command uses <a href="https://www.npmjs.com/package/nodemon">nodemon</a>
to listen for changes to **server-side code** (Node.js modules) and automatically restart the server. If you do not want
this, run instead `npm run start:dev:no-hot-reload` or `npm run start:dev:windows:no-hot-reload`.
If you are developing as well, in a separate terminal, execute `npm run build:dev`. This uses <a href="https://webpack.js.org/">
If you are making changes to client-side javascript, in a separate terminal, execute `npm run build:dev`. This uses <a href="https://webpack.js.org/">
Webpack</a> to bundle javascript from the `client/src` directory and place it in the `client/dist` directory, which is ignored by Git.
This command uses the `--watch` flag, which means the process will continue
to run in this terminal, watching for changes to JavaScript within the `client/src` directory and re-bundling automatically. You
to run in this terminal, watching for changes within the `client/src` directory and re-bundling automatically. You
definitely want this if making frequent JavaScript changes to client-side source code. Any other changes, such as to HTML or CSS
files, are not bundled, and thus your changes will be picked up simply by refreshing the browser.