Go to file Use this template
Riffaells 0527922828 update style 2024-12-03 11:41:26 +05:00
src update style 2024-12-03 11:41:26 +05:00
.editorconfig use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
.eslintignore fix .eslintignore (#48) 2023-01-19 10:06:51 -05:00
.eslintrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
.gitignore first commit 2024-12-01 13:37:02 +05:00
.npmrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
README.md creating future localizations, and adding readme 2024-12-01 13:50:40 +05:00
README_RU.md creating future localizations, and adding readme 2024-12-01 13:50:40 +05:00
esbuild.config.mjs first commit 2024-12-01 13:37:02 +05:00
manifest.json first commit 2024-12-01 13:37:02 +05:00
package.json update styles 2024-12-01 19:57:16 +05:00
styles.css update style 2024-12-03 11:41:26 +05:00
tsconfig.json Fix inconsistent indentation 2024-01-19 21:14:58 +02:00
version-bump.mjs add version bump script (#10) 2022-01-22 16:13:50 -05:00
versions.json Update for 0.15 2022-08-09 13:38:50 -04:00

README.md

ChessMate Plugin for Obsidian

ChessMate Plugin is a plugin for Obsidian that enables displaying chess games and positions in PGN and FEN formats directly within your notes. The plugin uses the lichess-pgn-viewer library to render boards and pieces.


Features

  • Display Chess Games: Use code blocks with the chessmate type to visualize chess games in PGN format.

  • Customizable Display: Supports configuration for board themes, piece styles, and board size.

  • Chess Notation Support: Replay and study games with textual annotations and comments.


Installation

Manual Installation

  1. Download the manifest.json, main.js, and styles.css files from the latest release in the repository.
  2. Place them in the .obsidian/plugins/chessmate-plugin/ folder of your vault.
  3. Reload Obsidian and activate the plugin in Settings > Community Plugins.

Usage

Displaying a Chess Game

Insert the following example into your note:

```chessmate
[Event "Example Game"]
[Site "Obsidian"]
[Date "2024.12.01"]
[Round "?"]
[White "Player1"]
[Black "Player2"]
1. e4 e5 2. Nf3 Nc6 3. Bb5 a6 4. Ba4 Nf6 5. O-O Be7 6. Re1 b5