summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoffrey Bion <joffrey.bion@booking.com>2020-05-27 18:26:20 +0200
committerJoffrey Bion <joffrey.bion@booking.com>2020-05-27 18:26:30 +0200
commit8710e4d92513d67acdb4b03adad0c3ee739e44e6 (patch)
treed64030e3feace2c437f55e5a1d921f2f3c335434 /README.md
parentRemove useless z-index (diff)
downloadseven-wonders-8710e4d92513d67acdb4b03adad0c3ee739e44e6.tar.gz
seven-wonders-8710e4d92513d67acdb4b03adad0c3ee739e44e6.tar.bz2
seven-wonders-8710e4d92513d67acdb4b03adad0c3ee739e44e6.zip
Update development status in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 24 insertions, 35 deletions
diff --git a/README.md b/README.md
index 5e6fa74c..8172b79d 100644
--- a/README.md
+++ b/README.md
@@ -3,48 +3,37 @@
[![Travis Build](https://img.shields.io/travis/joffrey-bion/seven-wonders/master.svg)](https://travis-ci.org/joffrey-bion/seven-wonders)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/joffrey-bion/seven-wonders/blob/master/LICENSE)
-A digital version of the famous [7 Wonders board game](https://en.wikipedia.org/wiki/7_Wonders_(board_game)).
+A digital version of the [7 Wonders board game](https://en.wikipedia.org/wiki/7_Wonders_(board_game)).
-## Work in progress
+> :warning: **DISCLAIMER:** We do not own the rights on the 7 Wonders game concept and rules,
+> nor on the assets used here. This is a pet project, not intended to be sold.
-A very early (staging) version of the app is running [on heroku](https://seven-wonders-online.herokuapp.com/).
-It is of course still under development and not usable yet because the development of the client just started.
-Also, it is very unstable as it is a staging server where the app is redeployed after every successful build of the
-master branch.
-
-### Server
+## :construction: Work in progress
-The websocket server API handles most of the game steps:
-- Define your username
-- Create / Join a game
-- View joined lobby
-- Start game
-- View your hand and the table
-- Make moves / See other's moves
+A staging version of the app is running [on heroku](https://seven-wonders-online.herokuapp.com/).
+It is of course still under development, so some features are missing (some wonder bonuses for instance).
-Missing steps:
-- End of game event
-- Access scoring
+Also, the staging server is quite unstable as the CI/CD pipeline deploys the new app on it after every successful
+build of the master branch. Don't play serious games there :smile:
+
+### Server state
-A [live API documentation using JsonDoc](https://seven-wonders-online.herokuapp.com/livedoc-ui.html?url=https://seven-wonders-online.herokuapp.com/jsondoc)
-is available. It is in construction as well because I'm adding wesocket support to the existing REST-API support.
+The websocket server API handles all the game steps, including special bonuses and end-of-game moves.
-### Client
+### Client state
-The client is just at the start of the development. It handles:
+The client handles the major features to play a full game:
- Username choice
- Create / Join a game
-- View joined lobby
+- View joined lobby / Add bot players
- Start game
-- View personal board
-- Play/discard cards, upgrade wonder
-
-Missing features:
-- View other boards' elements
-- Buy resources from neighbours
-- Pick neighbour guild (for special power)
-- Display winner and score
-
-## Disclaimer
-
-We do not own the rights on the 7 Wonders game concept and rules, nor on the assets used here.
+- View personal board, and other players' board summaries
+- Play/discard cards or upgrade wonder (auto-buying missing resources from neighbours)
+- Display the score board
+
+:construction: It lacks the following features:
+- View full boards of other players
+- Control which resources to buy from which neighbour
+- "Special power" actions:
+ - Play a card from discarded cards deck
+ - Pick neighbour guild to copy
bgstack15