https://github.com/dr-42/chess-book-study
A simple companion app for when you are reading chess pdfs.
https://github.com/dr-42/chess-book-study
chess chess-game chessboard reading
Last synced: 6 months ago
JSON representation
A simple companion app for when you are reading chess pdfs.
- Host: GitHub
- URL: https://github.com/dr-42/chess-book-study
- Owner: Dr-42
- License: bsd-2-clause
- Created: 2023-08-14T10:01:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-27T17:21:47.000Z (7 months ago)
- Last Synced: 2024-11-27T18:29:09.677Z (7 months ago)
- Topics: chess, chess-game, chessboard, reading
- Language: TypeScript
- Homepage:
- Size: 2.27 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://tauri.app/v1/guides/getting-started/prerequisites)
Install the typescript compiler either from npm or your package manager.
#### Using npm
```sh
npm install -g typescript
```
#### Using pacman
```sh
pacman -S typescript
```
After the prerequisites are installed, clone the repo and run the following commands:
```sh
npm install --save-dev @tauri-apps/cli
tsc
npm run tauri dev
```
## Screenshots
