From 32cd2d480b6185e1d1382055297715c24bc95cb5 Mon Sep 17 00:00:00 2001 From: tslil clingman <> Date: Sat, 7 Mar 2020 21:36:35 -0800 Subject: Actually it should be an MD --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.org | 46 ---------------------------------------------- wrap_taktician | 2 +- 3 files changed, 52 insertions(+), 47 deletions(-) create mode 100644 README.md delete mode 100644 README.org diff --git a/README.md b/README.md new file mode 100644 index 0000000..a01db3f --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# A TUI for local play of the game of Tak + +## Building + +Clone the repo, issue `cargo build` and enjoy (?) + +## Usage + +Takwrap supports local play, undo, and starting variant and game +exporting to PTN. See `takwrap -h` for options and details. + +Note in particular that `takwrap` supports the following alternate +starting configurations, which are embedded in the exported PTN file +as `[Variant XXX]`. + +- CPSn, counter-play start with n=1 is the default. + + White places a black flat, then black places a white flat. This + repeats n times, after which normal play resumes. + +- FCS, forbidden corner start. + + CPS1 but white may not place the black flat in a corner + +- FES, forbidden edge start. + + CPS1 but white may not place the black flat on an edge + +- TPS, two ply start. + + White places two black flats, then black places a white flat and + normal play resumes. + +- CZS, Czech start. + + White places a black flat, then normal play resumes + +## Interfacing with engines + +Takwrap does not have computer opponents built in, but instead allows +interfacing with external engine programmes with the `-e` parameter. +It expects the name of an executable in the path which accepts the +name of a file with a game-state in PTN, and which returns a single, +valid move. + +See the file `wrap_taktician` for an example of utilising [Taktician](https://github.com/nelhage/taktician) +for this purpose. + +Note that the engine is expected to respect the `[Variant XXX]` line +in the PTN game-state, so expect breakage with anything but the +default. diff --git a/README.org b/README.org deleted file mode 100644 index 28593c5..0000000 --- a/README.org +++ /dev/null @@ -1,46 +0,0 @@ -* A TUI wrapper for local play of the game of Tak - -** Building - -Clone the repo, issue `cargo build` or and enjoy (?) - -** Usage - -Takwrap supports local play, undo, and starting variant and game -exporting to PTN. See `takwrap -h` for options and details. - -Note in particular that `takwrap` supports the following alternate -starting configurations, which are embedded in the exported PTN file -as `[Variant XXX]`. - -- CPSn, counter-play start with n=1 is the default - White places a black flat, then black places a white flat. This - repeats n times, after which normal play resumes. - -- FCS, forbidden corner start - CPS1 but white may not place the black flat in a corner - -- FES, forbidden edge start - CPS1 but white may not place the black flat on an edge - -- TPS, two ply start - White places two black flats, then black places a white flat and - normal play resumes. - -- CZS, Czech start - White places a black flat, then normal play resumes - -** Interfacing with engines - -Takwrap does not have computer opponents built in, but instead allows -interfacing with external engine programmes with the `-e` parameter. -It expects the name of an executable in the path which accepts the -name of a file with a game-state in PTN, and which returns a single, -valid move. - -See the file `wrap_taktician` for an example of utilising [[https://github.com/nelhage/taktician][Taktician]] -for this purpose. - -Note that the engine is expected to respect the `[Variant XXX]` line -in the PTN game-state, so expect breakage with anything but the -default. diff --git a/wrap_taktician b/wrap_taktician index f61fe12..c0ec20a 100755 --- a/wrap_taktician +++ b/wrap_taktician @@ -1,3 +1,3 @@ #!/bin/bash -taktician analyze -quiet -mcts -limit 3s -depth 1 $1 | rg = | cut -d= -f2 | shuf -n 1 +taktician analyze -quiet -mcts -limit 3s -depth 1 $1 | grep = | cut -d= -f2 | shuf -n 1 -- cgit v1.3.1