wandererxii / shogiops

Shogi rules and operations in TypeScript

shogiops

Shogi and operations in TypeScript forked from chessops, rewritten for shogi.

Features

• Read and write SFEN
• Vocabulary (Square, SquareSet, Color, Role, Piece, Board, Position)
• Shogi
  • Move/drop making
  • Legal move and drop move generation
  • Game end and outcome
  • Setup validation
• Attacks and rays using hyperbola quintessence
• Read and write USI, Japanese, Western and Kitao-Kawasaki notation
• Read and write KIF and CSA notation
• Currently supported variants - shogi, minishogi, chushogi, annan shogi and kyoto shogi.
• Compatibility with shogiground
• Compatibility with lishogi

File an issue to request more or report a bug.

Example

Test directory has a lot of examples and use-cases.

import { Shogi } from 'shogiops/shogi';
import { parseUsi } from 'shogiops/util';

const pos = Shogi.default();
const usi = parseUsi('7g7f')!;
pos.play(usi);

License

shogiops is licensed under the GNU General Public License 3 or any later version at your choice. See LICENSE.txt for details.

shogiops's Issues

Chu shogi notation

It wasn't clear to me how to translate a USI move list from https://lishogi.org/api#tag/Games/operation/apiUserCurrentGame into western or other notations.
ddugovic/lishogi-discord@18ff16b

pos.clone() is not defined

I'm attempting to make a Discord bot which displays a player's recent games, with a human-readable move list. But I see in shogi.js that clone() is defined, so I must be making a coding error somehow:

https://github.com/ddugovic/lishogi-discord/blob/2ca5f2519bb535f78fdad6e39bf1b2a587540e48/lib/format-variation.js#L1-L34

shogiops/src/notation/csa/csa.ts

Lines 191 to 201 in c3d6424

	export function parseCsaMoves(pos: Position, csaMoves: string[]): Move[] {
	pos = pos.clone();
	const moves: Move[] = [];
	for (const m of csaMoves) {
	const move = parseCsaMove(pos, m);
	if (!move) return moves;
	pos.play(move);
	moves.push(move);
	}
	return moves;
	}

SquareSet.first is bugged

Testing code

var shogi = require('shogiops').Shogi.fromSetup(require('shogiops/fen').parseFen('9/5n1+R+B/5pk2/9/9/9/9/9/9 w rb4g4s3n4l17p 2').unwrap(), false).unwrap();
var dests = shogi.allDests();
console.log(dests);

// array of possible squares the king can move to, should print [ 50 ]
console.log(Array.from(dests.get(60)))

// should print 50 but prints 26 instead for some reason
console.log(dests.get(60).first())

I worked around the bug in ui/learn by using Array.from(dests.get(60))[0] instead of .first(), so there is no rush fixing it.