This is a library for chess positions. It is a work in progress.
Note: the below is partial documentation of the chessview API. Like the project itself, it is a work in progress. I hope to fully document the API eventually.
FEN.parse(fenSource)returns the Position object represented by the FEN-encoded fenSource
FEN.stringify(position)returns the FEN-encoded string representing the given Position object
FEN.standarda string encoding of the standard starting position.
FEN.standardPositionthe Position object obtained by calling FEN.parse(FEN.standard).
PGN.parse(pgnSource)returns an array of Game objects.
PGNs can contain a single game, or a collection of many games. This method always returns an array of the one or more Game objects represented by that PGN.
Algebraic.parse(moveNotation)returns a { piece, move } literal with the piece and "move" (coordinates) described by the algebraic notation-encoded moveNotation.
This class represents a given position of chess. It doesn't necessarily represent a legal position, although it can only beget positions which follow from legal moves. Each position is immutable.
new Position(options)Where:
ranks=8files=8activeColor=WHITEcastling=nullenPassantTarget=nullhalfmoveClock=nullfullmoveCounter=0board=new Board(ranks, files)This constructor is generally not used directly. Instead, you'd usually come about a new Position object by calling FEN.parse() or position.move().
position.beget(overrides)Return a new Position that is exactly the same as the current position, except for the properties of overrides. This method is not generally used directly. Instead, you'd normally use position.move()
position.move(moveNotation)returns a new Position object representing the position after the give moveNotation, which is a string of
throws a MobilityError if the move is illegal because a piece would be blocked, because the target square is occupied by a friendly piece, or because there is no suitable piece on the board able to move to that square by definition.
throws a CheckError if the move is illegal because it would leave the King in check.
position.movePiece(piece, target)like position.move(), but lower level, and handier for UI programming. Instead of taking the move in algebraic notation, it takes the piece and the coordinates of the target square.
position.tryMovePiece(piece, target)like position.movePiece(), except it doesn't throw, and instead returns the position itself upon error. This makes it even handier for UI programming (pieces snap back home on an illegal move), but worthless for analysis, where the question of move legality is important, since that information will be silenced.
position.moves()returns an iterator of every legal move in the given position.
position.checks(color=activeColor,loc=activeKingLoc)returns an iterator of every check in the given position. This can also be used speculatively, to wonder what checks would exist if the king were on a given square.
position.pieces(selector)returns an iterator of all the pieces matching the selector, where the selector describes the color and/or brand of the pieces in question.
position.piece(selector)returns the first piece matching the selector.
position.all(selector)returns an array of all the pieces matching the selector.
A line is an accumalator of moves and corresponding immutable positions.
new Line(position=FEN.standardPosition)instantiates a new Line object.
line.move(moveNotation)accumulate a new { position, move, note } literal, where position is the Position object obtained by calling position.move(move) on the line's current position, and note is an optional annotation.
line.annotate(note)add a note to, or replace the existing note of, the current { position, move } literal.
line.plyLengththe length of the line, measured by ply.
line.lengththe length of the line, measured by moves.
A Game object is a Line, accompanied by some optional tags.
new Game(position=FEN.standardPosition, tags)instantiates a new Game object.
game.addTag(tag)add a tag to the game's collection of tags.
Checked items are implemented
MIT (See LICENSE)
FAQs
A view for chess positions
We found that chesslib demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.