← Back to plugins index

♟️ Chess

This plugin displays the last game you played on a supported chess platform.

⚠️ Disclaimer

This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with any of the supported provider. All product and company names are trademarks™ or registered® trademarks of their respective holders.

Authors@lowlighter
Supported features
→ Full specification		 📗 Classic template
👤 Users 👥 Organizations 📓 Repositories
🗝️ plugin_chess_token
## ➡️ Available options
OptionDescription

plugin_chess

Enable chess plugin
type: boolean
default: no

plugin_chess_token

Chess platform token
🔐 Token
🌐 Web instances must configure settings.json:
  • metrics.api.chess.any
type: token

plugin_chess_user

Chess platform login
⏯️ Cannot be preset
type: string
default: → User login

plugin_chess_platform

Chess platform
type: string
allowed values:
  • lichess.org

plugin_chess_animation

Animation settings

  • size is the size of a single chessboard square in pixels (board will be 8 times larger)
  • delay is the delay before starting animation (in seconds)
  • duration is the duration of the animation of a move (in seconds)
type: json
default:
→ Click to expand
{
  "size": 40,
  "delay": 3,
  "duration": 0.6
}

## 🗝️ Obtaining a lichess.org token Create a [lichess.org account](https://lichess.org) and select [API access tokens](https://lichess.org/account/oauth/token) to get a token. ![lichess.org token](/.github/readme/imgs/plugin_chess_lichess_token_0.png) It is not necessary to add additional scopes: ![lichess.org token](/.github/readme/imgs/plugin_chess_lichess_token_1.png) Create token and store it in your secrets: ![lichess.org token](/.github/readme/imgs/plugin_chess_lichess_token_0.png) ## ℹ️ Examples workflows ```yaml name: Last chess game from lichess.org uses: lowlighter/metrics@latest with: filename: metrics.plugin.chess.svg token: NOT_NEEDED base: "" plugin_chess: yes plugin_chess_token: ${{ secrets.CHESS_TOKEN }} plugin_chess_platform: lichess.org ```