summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoffrey Bion <joffrey.bion@booking.com>2020-07-31 20:10:29 +0200
committerJoffrey Bion <joffrey.bion@booking.com>2020-08-09 13:06:09 +0200
commit2c1ae7690db75a4750bc115a69e91147715ca22a (patch)
tree08361f5d44b1f2b8767a229cb5ccbf72043c21e6 /README.md
parentAdd screenshots in doc folder (diff)
downloadseven-wonders-2c1ae7690db75a4750bc115a69e91147715ca22a.tar.gz
seven-wonders-2c1ae7690db75a4750bc115a69e91147715ca22a.tar.bz2
seven-wonders-2c1ae7690db75a4750bc115a69e91147715ca22a.zip
Add screenshots to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 44 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9fed0cb7..a70b0fd7 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,49 @@ A digital version of the [7 Wonders board game](https://en.wikipedia.org/wiki/7_
## :construction: Work in progress
A staging version of the app is running [on heroku](https://seven-wonders-online.herokuapp.com/).
+Heroku's free plan shuts down servers when not used for 30 minutes, so please allow for a bit of delay (~30s) if you're
+ trying it on a cold start.
It is still under development, so the staging server is 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:
+it after every successful build of the master branch.
+It is therefore possible that you experience a server restart if I just pushed some new changes.
+
+## Technicalities
+
+This project is written 100% in Kotlin. You can find the history of the technical decisions in the
+[decisions history](doc/decisions_history.md) document.
+
+This project uses websockets and STOMP for the communication between frontend and backend.
+For this, it uses the [krossbow](https://github.com/joffrey-bion/krossbow) multiplatform library.
+
+## How does it look?
+
+The game contains most features of the actual board game:
+
+- Play cards, discard, or upgrade your wonder
+- Buy resources from your neighbours
+- Special bonuses: pick from discarded cards, play your 2 last cards, copy neighbour guild etc.
+
+Missing features:
+
+- You can't currently choose which neighbour you buy the resources from. The game automatically picks the
+ cheapest option for you.
+
+Online-only features:
+
+- Add bots to play with you, even if you're less than the minimum 3 players
+- The game greys out the cards you can't afford and the actions you can't perform
+- You can see a preview of the cost of each action (play or upgrade)
+- Save time to compute the score!
+
+Some screenshots:
+
+| Basic board | Hover to see your hand|
+| --- | --- |
+| ![Basic board](doc/screenshots/basic-board.png?s=250) | ![Hand hover](doc/screenshots/hand-hover2.png) |
+
+Preview your opponents' boards:
+
+| In front | Left neighbour | Right neighbour |
+| --- | --- | --- |
+| ![Board preview 1](doc/screenshots/neighbour-preview1.png?s=300) | ![Board preview 2](doc/screenshots/neighbour-preview2.png?s=200) | ![Board preview 3](doc/screenshots/neighbour-preview3.png) |
bgstack15