Skip to content

A simple companion app for when you are reading chess pdfs.

License

Notifications You must be signed in to change notification settings

Dr-42/chess-book-study

Repository files navigation

Chess Book Study

A simple companion app for when you are reading pdfs.


When you are reading a chess book on your computer, sometimes don't you feel a floatiing chessboard would solve most of your visualisaztion problems? Well this does exactly that.

Features

  • Only valid moves can be played
  • Always on top option
  • Board editing
  • FEN and PGN display for easy export
  • 9 different piece sets
  • Fully customisable board theme
  • Sounds!!

Usage

Use prebuilt binaries

On windows, just grab the msi installer. I have not able to generate the AppImage with tauri, so I am distributing a namked binary. The assets are embedding in the sourcecode, So don't worry about it.

Compiling from source

This is a standard tauri app written in typescript with no frameworks, hence this should be fairly easy to compile and run if you are familiar with the tauri ecosystem. If not follow Tauri quickstart

Install the typescript compiler either from npm or your package manager.

Using npm

npm install -g typescript

Using pacman

pacman -S typescript

After the prerequisites are installed, clone the repo and run the following commands:

npm install --save-dev @tauri-apps/cli
tsc
npm run tauri dev

Screenshots

Screenshot 2023-08-18 145401

Screenshot 2023-08-18 145623

Screenshot 2023-08-18 145724

Screenshot 2023-08-18 145804