Skip to content

Commit

Permalink
added README
Browse files Browse the repository at this point in the history
  • Loading branch information
minhyeong-joe committed Aug 12, 2020
1 parent d6c0b53 commit 7704596
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# [Sabotage Game](sabotage-chat.herokuapp.com)

Sabotage Game is a chat-based web game in which players try to find out a random spy among themselves.

**Any constructive feedbacks are always welcome and appreciated!**

## Game rule

![rule](README_img/game_rule.png)

**Requires at least 3 players**

---

## Development Notes

Please note that this project is for hobby.

- Validations and game-play may not cover some edge cases, so play as intended. (AKA, do not try to "hack")
- It is designed for desktop play, not mobile (yet).
- It is never intended for large traffic.
- socket.io disconnects and reconnects as new socket on refresh. During game-play, a refresh will automatically be considered as being "voted out", so avoid using refresh in-game.

### Todos:

- [x] Chat bubble colors
- [x] Chat spam prevention
- [x] Empty chat prevention
- [x] Input sanitization
- [x] vote, sabotage timer
- [x] Chat characters limit
- [x] Font selection
- [x] Game sounds
- [ ] Private Room
- [ ] Display who has voted (and maybe to whom?)
- [ ] Mobile-friendly UI/UX
- [ ] Show locale time instead of server time
- [ ] Better UI for invalid access (instead of simple `alert()`)
Binary file added README_img/game_rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7704596

Please sign in to comment.