1895391f40
|
||
|---|---|---|
| src | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .npmrc | ||
| README.md | ||
| README_RU.md | ||
| esbuild.config.mjs | ||
| manifest.json | ||
| package.json | ||
| styles.css | ||
| tsconfig.json | ||
| version-bump.mjs | ||
| versions.json | ||
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
chessmatetype 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
- Download the
manifest.json,main.js, andstyles.cssfiles from the latest release in the repository. - Place them in the
.obsidian/plugins/chessmate-plugin/folder of your vault. - 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