Commit 1cda60b9 authored by Vivien Kraus's avatar Vivien Kraus

Merge branch '15-update-the-documentation' into 'develop'

Resolve "Update the documentation"

Closes #15

See merge request gugurumbe/tarot!14
parents a544c37d 2f05d7e3
Pipeline #95578 failed with stages
in 2 minutes and 28 seconds
......@@ -628,6 +628,10 @@ The commands are:
- =version=: print the package version;
- =license=: state the license of the package;
- =status=: print the current status of the game;
- =status with imputation=: impute the missing cards, and print the
status as if we knew all cards[fn::You can repeat this command to
have different imputations; it may not work every time but the
random seed will change.];
- =load "filename"=: load the game from file;
- =save "filename"=: save the game to disk;
- =check <event>=: check that the event may be applied;
......@@ -659,6 +663,85 @@ The game events are:
To quit the program, simply send =EOF= to the terminal, usually with
control + D.
Here is an example of session with a deal to the fifth player:
#+BEGIN_EXAMPLE
setup 5 with call
deal 19T 18T 17T 16T 15T 14T 13T 12T 11T EXC \
KH QH CH JH 10H \
to P5
bid take
bid pass
bid pass
bid pass
bid pass
decl pass
decl pass
decl pass
decl pass
decl slam
call KC
dog 6H 7H 8H
discard
handful EXC 11T 12T 13T 14T 15T 16T 17T 18T 19T
play 19T
handful 1T 2T 3T 4T 5T 6T 7T 8T 9T 10T
play 10T
play 20T
play 21T
play 6C
play AC
play 7C
play 11T
status with imputation
#+END_EXAMPLE
And here is how it would be if you passed the deal for all players:
you recognize the owners for the minor suits (P6 being the dog), then
the owners for the trumps, then the owner of the excuse.
#+BEGIN_EXAMPLE
setup 5 with call
deal P1 P1 P1 P1 P1 P6 P6 P6 P4 P5 P5 P5 P5 P5 \
P3 P3 P3 P3 P3 P4 P4 P4 P4 P2 P2 P2 P2 P2 \
P3 P3 P3 P3 P3 P4 P4 P4 P4 P2 P2 P2 P2 P2 \
P3 P3 P3 P3 P4 P4 P4 P4 P4 P4 P2 P2 P2 P2 \
P1 P1 P1 P1 P1 P1 P1 P1 P1 P1 P5 P5 P5 P5 P5 P5 P5 P5 P5 P2 P3 \
P5
bid take
bid pass
bid pass
bid pass
bid pass
decl pass
decl pass
decl pass
decl pass
decl slam
call KC
dog 6H 7H 8H
discard AH 2H 3H
handful EXC 11T 12T 13T 14T 15T 16T 17T 18T 19T
play 19T
handful 1T 2T 3T 4T 5T 6T 7T 8T 9T 10T
play 10T
play 20T
play 21T
play 6C
play AC
play 7C
play 11T
status with imputation
#+END_EXAMPLE
* The libtarot API
In this section, we are going to describe the entrypoints of the
libtarot API.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment