https://github.com/silentvoid13/chesser

A chess plugin for obsidian
https://github.com/silentvoid13/chesser

obsidian-md obsidian-plugin

Last synced: about 2 months ago
JSON representation

A chess plugin for obsidian

• Host: GitHub
• URL: https://github.com/silentvoid13/chesser
• Owner: SilentVoid13
• License: agpl-3.0
• Created: 2021-02-26T21:18:37.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-11T19:35:59.000Z (over 1 year ago)
• Last Synced: 2024-10-15T07:28:54.390Z (2 months ago)
• Topics: obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 5.03 MB
• Stars: 112
• Watchers: 5
• Forks: 14
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.TXT

Awesome Lists containing this project

README

        
# Chesser

A chess game viewer/editor for [Obsidian](https://obsidian.md/).

## Demonstration

![chesser_demo](https://raw.githubusercontent.com/SilentVoid13/Chesser/master/imgs/chesser_demo.gif)

## Usage

To use [Chesser](https://github.com/SilentVoid13/Chesser), you first need to declare a `chess` code block like so:

![chesser_block](imgs/chesser_block.png)

This will create a basic chess board in the start position.

You can declare various settings **inside** the `chess` code block, like a [FEN](https://en.wikipedia.org/wiki/Forsyth%E2%80%93Edwards_Notation) string to describe a particular board position. You can find the full settings list below.

## Settings

Here are the available settings for a `chesr` code block:

| Name          | Possible Values                                              | Description                                                  |

| ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |

| `fen`         | A valid FEN string                                           | Starts the chess board with a particular position.           |

| `orientation` | `white`/`black`                                              | Orientation of the board.                                    |

| `pieceStyle`  | A valid piece style name.
Check [this](https://github.com/SilentVoid13/Chesser/tree/master/assets/piece-css) to view available styles. | Style of the pieces on the board.                            |

| `boardStyle`  | A valid board style name.
Check [this](https://github.com/SilentVoid13/Chesser/tree/master/assets/board-css) to view available styles. | Style of the chess board.                                    |

| `drawable`    | `true`/`false`                                               | Controls the ability to draw annotations (arrows, circles) on the board. |

| `viewOnly`    | `true`/`false`                                               | If enabled, displays a static chess board (no moves, annotations, ...). |

| `free`        | `true`/`false`                                               | If enabled, disables the chess logic, all moves are valid.   |

You can permanently set some settings in [Chesser](https://github.com/SilentVoid13/Chesser)'s obsidian plugin settings.

## TODO

- [ ] Add [PGN](https://en.wikipedia.org/wiki/Portable_Game_Notation) format support

## Installation

After disabling Safe Mode, you can find third-party plugins in Settings > Community plugins > Browse > Search for "Chesser".

After installing, you can then find the installed plugins under Settings > Community plugins. They need to be enabled in order to take effect. You can also uninstall them there.

## Alternatives

- [THeK3nger/obsidian-chessboard](https://github.com/THeK3nger/obsidian-chessboard)

## Contributing

Feel free to contribute.

You can create an [issue](https://github.com/SilentVoid13/Chesser/issues) to report a bug, suggest an improvement for this plugin, etc.

You can make a [pull request](https://github.com/SilentVoid13/Chesser/pulls) to contribute to this plugin development.

## License

[Chesser](https://github.com/SilentVoid13/Chesser) is licensed under the GNU AGPLv3 license. Refer to [LICENSE](https://github.com/SilentVoid13/Chesser/blob/master/LICENSE.TXT) for more informations.

## Support

If you want to support me and my work, you can donate me a little something by clicking [**here**](https://www.paypal.com/donate?hosted_button_id=U2SRGAFYXT32Q).