Giter VIP home page Giter VIP logo

chesser's Introduction

Chesser

A chess game viewer/editor for Obsidian.

Demonstration

chesser_demo

Usage

To use Chesser, you first need to declare a chess code block like so:

chesser_block

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

You can declare various settings inside the chess code block, like a FEN 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 to view available styles.
Style of the pieces on the board.
boardStyle A valid board style name.
Check this 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's obsidian plugin settings.

TODO

  • Add PGN 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

Contributing

Feel free to contribute.

You can create an issue to report a bug, suggest an improvement for this plugin, etc.

You can make a pull request to contribute to this plugin development.

License

Chesser is licensed under the GNU AGPLv3 license. Refer to LICENSE for more informations.

Support

If you want to support me and my work, you can donate me a little something by clicking here.

chesser's People

Contributors

liamcain avatar silentvoid13 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.