aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorrodri <rgl@antares-labs.eu>2023-08-31 10:16:12 +0000
committerrodri <rgl@antares-labs.eu>2023-08-31 10:16:12 +0000
commit68cfdc52fa2daecdd2b4db02fe5f117a4e2329f6 (patch)
tree406f9c7c4175818285c36c6e076d08f910988433 /readme.md
parentbe547a2dba10292fb3191bc5fec42212d2391660 (diff)
downloadbattleship-68cfdc52fa2daecdd2b4db02fe5f117a4e2329f6.tar.gz
battleship-68cfdc52fa2daecdd2b4db02fe5f117a4e2329f6.tar.bz2
battleship-68cfdc52fa2daecdd2b4db02fe5f117a4e2329f6.zip
improved playerq locking.
wrote a little how to play guide.
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 5f11e64..99e346c 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,30 @@
# Battleship
An on-line multi-player implementation of Battleship (a.k.a. Sink the Fleet).
+
+# How to play
+
+Join a server
+
+ % bts antares-labs.eu
+
+Then wait for another player to show up (admire the velero). When
+they do, you'll have to place your ships in the lower (local) board by
+clicking LMB when the ship is at the right location; you can also
+change the orientation of the ship by pressing MMB and selecting
+“rotate ship”. If you are not happy with the current layout, press
+RMB and select “place ships” to start all over again (tip: if you
+don't want to move a ship, click LMB without moving the mouse.) Once
+you are done—a banner at the bottom will inform you—, press RMB and
+choose “done”.
+
+At this moment the battle will begin. Each of you has a turn (read
+[battleship.pdf](battleship.pdf)), and if you are the one shooting you
+have to aim at a tile at the upper (target) board—which will show a
+reticle—and press LMB to fire a shot. If you hit an enemy ship, the
+tile will show an X, otherwise a O. If you are the one waiting, well,
+just do that.
+
+There's no turn timeout so the battles can get as long as any of the
+players's will. If you quit or your connection is lost, your opponent
+wins.