TPS Ninja

Install for including in JavaScript project:

npm i --save 'tps-ninja'

or

yarn add 'tps-ninja'

then

import { PTNtoTPS, TPStoPNG, TPStoGIF } from "tps-ninja";

---

Install for global CLI usage:

npm i -g tps-ninja

OR

Download the project, cd into its directory, then...

npm i && npm link

---

PTN to TPS

Portable Tak Notation to Tak Positional System

JS Usage:

const tps = PTNtoTPS({ plies, [tps or size], [...options] });

Required options are plies and either tps or size.

Examples:

PTNtoTPS({ tps: "x5/x5/x5/x5/2,x4 2 1", plies: ["a5", "b5", "c5"] });
// Returns "1,1,2,x2/x5/x5/x5/2,x4 1 3"

PTNtoTPS({ size: 6, plies: ["a6", "b6", "c6"], opening: "no-swap" });
// Returns "1,2,1,x3/x6/x6/x6/x6/x6 2 2"

CLI Usage:

PTNtoTPS <TPS|board size> [OPTION=VALUE ...] <ply1> [<ply2> ...]

Examples:

$ PTNtoTPS "x5/x5/x5/x5/2,x4 2 1" a5 b5 c5
> 1,1,2,x2/x5/x5/x5/2,x4 1 3

$ PTNtoTPS 6 opening=no-swap a6 b6 c6
> 1,2,1,x3/x6/x6/x6/x6/x6 2 2

Options:

opening        [swap|no-swap] Opening variations
caps           Override number of cap stones for both players
flats          Override number of flat stones for both players
caps1          Override number of cap stones for Player 1
flats1         Override number of flat stones for Player 1
caps2          Override number of cap stones for Player 2
flats2         Override number of flat stones for Player 2

---

TPS to PNG

Tak Positional System to Portable Network Graphics

JS Usage:

const canvas = TPStoPNG(args, (streamTo = null));

The args argument is a map of options, of which size or tps are required.

If streamTo is defined, the image will be piped to the specified write stream. Otherwise, in a node environment, it will be output to ./takboard.png. The canvas is returned either way.

The canvas returned has the following additional proprties:

• ctx: Canvas context
• isGameEnd: Boolean denoting whether the game is in a finished state
• linenum: Integer denoting current move number
• player: Integer (1 or 2) denoting current player
• tps: TPS string of current board state
• id: String denoting either the game result (if isGameEnd) or current TPS

### CLI Usage:

```bash
TPStoPNG <TPS|board size> [OPTION=VALUE ...]

Examples:

Example 1:

TPStoPNG({
  tps: "1,1,12,x2/x5/x5/x5/2,x4 1 4",
  komi: 1,
  imageSize: "sm",
  name: "example1",
});

OR

$ TPStoPNG "1,1,12,x2/x5/x5/x5/2,x4 1 4" komi=1 imageSize=sm name=example1

Output: example1.png

Example 2:

TPStoPNG({
  size: 6,
  opening: "no-swap",
  ply: "a6",
  imageSize: "sm",
  theme: "zen",
  bgAlpha: 0,
  name: "example2",
});

OR

$ TPStoPNG 6 opening=no-swap ply=a6 imageSize=sm theme=zen bgAlpha=0 name=example2

Output: example2.png

Options:

theme           [ID|JSON] Theme
imageSize       [xs|sm|md|lg|xl] Image size
textSize        [xs|sm|md|lg|xl] Text size
bgAlpha         [0, 1] Background opacity
hlSquares       [true|false] Highlight last ply's squares
axisLabels      [true|false] Show board coordinate labels
axisLabelsSmall [true|false] Show board coordinate labels inside the board
turnIndicator   [true|false] Show turn indicator and player names
flatCounts      [true|false] Show flat counts
stackCounts     [true|false] Show stack counts
centerStackCounts [true|false] Show stack counts in piece center instead of corner
                Forced true when axisLabels and axisLabelsSmall are both true
moveNumber      [true|false|<number>] Show current move number
evalText        [true|false] Show current ply eval notation
komi            [half-integer] Bonus points awarded to Player 2
opening         [swap|no-swap] Opening variations
showRoads       [true|false] Show partial roads
unplayedPieces  [true|false] Show unplayed pieces
padding         [true|false] Pad the image
highlighter     [JSON] Square coordinates mapped to color, overrides highlight
suggestions     [JSON] Array of analysis suggestions to overlay on the board
                Each element can be a PTN string or an object with:
                  ptn|ply       PTN string of the suggested move
                  evaluation    Engine evaluation score
                  depth         Search depth
                  nodes         Number of nodes searched
                  totalGames    Total games (for opening book suggestions)
                  wins1         Player 1 wins (for opening book suggestions)
                  wins2         Player 2 wins (for opening book suggestions)
                  draws         Draws (for opening book suggestions)
                Placements render as ghost pieces; movements render as arrows

name           Filename of exported PNG, defaults to 'takboard.png'
player1        Name of Player 1
player2        Name of Player 2
hl             PTN of a ply whose affected squares will be highlighted
ply            PTN of a ply to be executed
plies          Space- or comma-separated string of plies to be executed
caps           Override number of cap stones for both players
flats          Override number of flat stones for both players
caps1          Override number of cap stones for Player 1
flats1         Override number of flat stones for Player 1
caps2          Override number of cap stones for Player 2
flats2         Override number of flat stones for Player 2

TPS to GIF

Tak Positional System to Graphics Interchange Format

JS Usage:

const stream = TPStoGIF(args, (streamTo = null));

The args argument is a map of options, of which size or tps are required.

If streamTo is defined, the image will be piped to the specified write stream. Otherwise, in a node environment, it will be output to ./takboard.gif. The read stream is returned either way.

CLI Usage:

TPStoGIF <TPS|board size> [OPTION=VALUE ...]

Examples:

TPStoGIF({
  size: 3,
  plies: ["a1", "b1", "b2", "b3", "c2", "b3-", "b3", "2b2-", "c1", "c3", "b2"],
  theme: "discord",
  imageSize: "sm",
  name: "example3",
});

OR

$ TPStoGIF 3 plies="a1 b1 b2 b3 c2 b3- b3 2b2- c1 c3 b2" theme=discord imageSize=sm name=example3

Output: example3.gif

Options:

delay          [integer] Milliseconds between frames (default 1000)
theme          [ID|JSON] Theme
imageSize      [xs|sm|md|lg|xl] Image size
textSize       [xs|sm|md|lg|xl] Text size
transparent    [true|false] Transparent background
hlSquares      [true|false] Highlight last ply's squares
axisLabels     [true|false] Show board coordinate labels
turnIndicator  [true|false] Show turn indicator and player names
flatCounts     [true|false] Show flat counts
stackCounts    [true|false] Show stack counts
centerStackCounts [true|false] Show stack counts in piece center instead of corner
               Forced true when axisLabels and axisLabelsSmall are both true
moveNumber     [true|false|<number>] Show current move number
evalText       [true|false] Show current ply eval notation
komi           [half-integer] Bonus points awarded to Player 2
opening        [swap|no-swap] Opening variations
showRoads      [true|false] Show partial roads
unplayedPieces [true|false] Show unplayed pieces
padding        [true|false] Pad the image
boardEvalBar   [true|false] Show evaluation bar in unplayed area
evaluation     [number] Position evaluation from -100 to 100
highlighter    [JSON] Square coordinates mapped to color, overrides highlight
suggestions    [JSON] Array of analysis suggestions to overlay on the board
               Each element can be a PTN string or an object with:
                 ptn|ply       PTN string of the suggested move
                 evaluation    Engine evaluation score
                 depth         Search depth
                 nodes         Number of nodes searched
                 totalGames    Total games (for opening book suggestions)
                 wins1         Player 1 wins (for opening book suggestions)
                 wins2         Player 2 wins (for opening book suggestions)
                 draws         Draws (for opening book suggestions)
               Placements render as ghost pieces; movements render as arrows
suggestionsByFrame [JSON] Per-frame suggestions for animated GIFs
               Array where index 0 applies to the initial frame and each
               subsequent index applies to each ply frame in order.
               Each frame value uses the same format as `suggestions`.
evaluationsByFrame [JSON] Per-frame evaluation values for animated GIFs
               Array where index 0 applies to the initial frame and each
               subsequent index applies to each ply frame in order.
delayAnalysis  [true|false] Insert a frame without analysis before each
               frame that has analysis suggestions

name           Filename of exported GIF, defaults to 'takboard.gif'
player1        Name of Player 1
player2        Name of Player 2
hl             PTN of a ply whose affected squares will be highlighted
ply            PTN of a ply to be executed
plies          Space- or comma-separated string of plies to be executed
caps           Override number of cap stones for both players
flats          Override number of flat stones for both players
caps1          Override number of cap stones for Player 1
flats1         Override number of flat stones for Player 1
caps2          Override number of cap stones for Player 2
flats2         Override number of flat stones for Player 2