In curso-r/chess: Read, Write, Create and Explore Chess Games

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "75%"
)

chess

Overview

{chess} is an opinionated wrapper for R around python-chess, an amazing library created by Niklas Fiekas. It allows users to read and write PGN files as well as create and explore game trees such as the ones seen in chess books.

Installation

Install the released version of {chess} from CRAN:

install.packages("chess")

Or install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("curso-r/chess")

This should automatically install python-chess to your {reticulate} environment, but you can also explicitly do it with a convenient function:

chess::install_chess()

Example

To read an existing game, simply use read_game(). To explore it you can use forward()/back(), as well as variations()/variation() to see all variations listed for the next move and choose one of them.

library(chess)

# Read final game from the Queen's Gambit
file <- system.file("harmon.pgn", package = "chess")
harmon_borgov <- read_game(file)

# Starting position
harmon_borgov

# Navigate to 2. c4
harmon_borgov %>%
  forward(3)

# See all variations for 2...
harmon_borgov %>%
  forward(3) %>%
  variations()

# Follow the sideline
harmon_borgov %>%
  forward(3) %>%
  variation(2)

Many other games are included with the package so you can get up and running as soon as you install {chess}! See vignette("games") for more information.

You can also create your own game with game() and add variations to it: the move() function adds moves as well as branches the tree of the game. Strings are converted to simple moves, while list()s behave exactly as parenthesis in PGN, creating a variation of the last move. Here you can see how to recreate a Scholar's mate and some ways to avoid it:

# Scholar's mate and some defenses
scholars_mate <- game() %>%
  move("e4") %>%
  move("e5", list("e6"), list("d5")) %>%
  move("Bc4") %>%
  move("Nc6", list("Nf6")) %>%
  move("Qh5") %>%
  move("Nf6", list("g6", "Qf3", "Nf6")) %>%
  move("Qxf7")

# Last mainline move
scholars_mate

Note that there are many ways to structure the input to move(). See vignette("chess") for more information.

{chess} also features many ways of seeing both the game as a whole and the board at a specific point in time.

# Print with unicode (doesn't look good on GitHub)
print(scholars_mate, unicode = TRUE)

# Export the FEN of the board
fen(scholars_mate)

# See the PGN after some move
str(back(scholars_mate, 3))

# Export the PGN after some move
pgn(back(scholars_mate, 3))

# Plot current board
plot(scholars_mate)

Motivation

python-chess served as the inspiration (and backbone) for {chess}. While the original version (and {rchess} for that matter) broadly handles "move generation, move validation" (with powerful classes and object-oriented syntax), {chess} focuses on making it easy to create and explore PGNs as trees.

By narrowing down the scope of the API, I believe the package becomes more intuitive to people who just want to quickly create shareable game analyses or easily explore other people's games without having to resort to point and click software.

{chess}'s first use was helping me study Bobby Fischer's My 60 Memorable Games. After some very difficult parsing, I was able to convert the whole book to PGN and upload it to lichess, but I still felt like the interface was too clumsy...

Roadmap

[X] NAGs
[X] Comments
[X] Headers
[X] Start game from FEN
[X] Better plotting
[X] More status functions
[X] Other OSs
[X] Unit tests
[X] Advanced usage
[X] Styler
[X] CRAN
[X] Stockfish API
[ ] Static boards (puzzles)
[ ] Shiny?

Code of Conduct

Please note that the {chess} project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.