https://github.com/LinusCDE/chessmarkable

Chess for the reMarkable using the rust pleco lib
https://github.com/LinusCDE/chessmarkable

pleco remarkable-tablet rust

Last synced: about 1 month ago
JSON representation

Chess for the reMarkable using the rust pleco lib

• Host: GitHub
• URL: https://github.com/LinusCDE/chessmarkable
• Owner: LinusCDE
• License: mit
• Created: 2020-10-04T06:08:13.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-28T00:20:34.000Z (about 2 years ago)
• Last Synced: 2024-08-02T15:46:39.451Z (4 months ago)
• Topics: pleco, remarkable-tablet, rust
• Language: Rust
• Homepage:
• Size: 331 KB
• Stars: 104
• Watchers: 7
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-reMarkable - chessMarkable - Play chess against a bot or a friend. (Applications / Games)

README

        
# chessMarkable

[![rm1](https://img.shields.io/badge/rM1-supported-green)](https://remarkable.com/store/remarkable)

[![rm2](https://img.shields.io/badge/rM2-supported-green)](https://remarkable.com/store/remarkable-2)

[![opkg](https://img.shields.io/badge/OPKG-chessmarkable-blue)](https://github.com/toltec-dev/toltec)

[![launchers](https://img.shields.io/badge/Launchers-supported-green)](https://github.com/reHackable/awesome-reMarkable#launchers)

[![Mentioned in Awesome reMarkable](https://awesome.re/mentioned-badge.svg)](https://github.com/reHackable/awesome-reMarkable)

A chess game for the reMarkable tablet writting using the [pleco](https://crates.io/crates/pleco) chess library which is a port of [Stockfish](https://stockfishchess.org/).

  

## Controlling

A chess piece can be moved in two ways:

1. Clicking it once and clicking the spot it's supposed to

2. Clicking it and moving the finger onto the square to move it there on release

The second method has the advantage that it doesn't highlight the chess piece or shows the possible moves.

## FEN

When running the Game with the enviroment variable `RUST_LOG` set to `debug`, the [FEN](https://en.wikipedia.org/wiki/Forsyth%E2%80%93Edwards_Notation) of a board will be output on each move. This is useful for debugging but also for manually saving a game state or resuming it elsewhere since this notation should be compatible with other chess programs/engines.

When starting a game, you'll need to specifiy a slot to play on. On quitting the game, the FEN will get saved to `~/.config/chessmarkable/savestates.yml` which can be used to resume from.

(The `-i` option was removed in favor to add your own fen to the above file).

## PGN Viewer

Chessmarkable also includes a PGN Player (huge thanks to [@rmadhwal](https://github.com/rmadhwal), for contributing this feature)!

You can put downloaded PGN Files into the directory `~/.config/chessmarkable/pgn` on the device with software like scp, FileZilla or WinSCP.

After this, you should be able to browse all the games from the menu point "PGN Viewer" and step through all the games.

## Installation

### Prebuilt binary/program

- Go the the [releases page](https://github.com/LinusCDE/chessmarkable/releases)

- Get the newest released binary file (the one without any extension) and copy it onto your remarkable, using e.g. FileZilla, WinSCP or scp.

- SSH into your remarkable and mark the file as executable with `chmod +x chess`

- Stop xochitl (the interface) with `systemctl stop xochitl`

- Start the game with `./chessmarkable` (or whatever the binary is called now)

- After you're done, restart xochitl with `systemctl start xochitl`

### Compiling

- Make sure to have rustup and a current toolchain (nightly might be needed)

- Install the [oecore toolchain](https://remarkablewiki.com/devel/toolchain).

  - If you're not using linux, you might want to adjust the path in `.cargo/config`

- Compile it with `cargo build --release`. It should automatically cross-compile.

## Todo

- Proper own icon(s)

- Clean the code

## reMarkable 2 support

This app cant actually drive the rM 2 framebuffer. It needs [rm2fb](https://github.com/ddvk/remarkable2-framebuffer/) for that.

If you execute chessmarkable from ssh, be sure to have followed rm2fb steps to enable the support. When installed running `rm2fb-client ./chessmarkable` should work as well. Launching through a launcher (from toltec) should just work.

## Credit

- The [pleco](https://crates.io/crates/pleco) library is used as the engine, checking valid moves and providing the bots

- The chess pices are from [pixabay here](https://pixabay.com/vectors/chess-pieces-set-symbols-game-26774/)