GithubHelp home page GithubHelp logo

liboard's Introduction

LiBoard

LiBoard

LiBoard is a custom layout for playing on lichess using the keyboard input. The idea is to minimize hand movement for an ergonomic online chess experience.

How to use

This is a chorded layout, meaning you press multiple keys at the same time to output one move. Note that your keyboard will need to support at least 6key rollover. You can test your keyboard using this site. Press various keys at once and verify that each of them light up.

Regular moves

The indexes are responsible for the pieces. For the queen, use rook + knight. For pawns, you press nothing.

The rest of the left hand is responsible for the file. Pressing the left pinky key uses the second set of letters, and not pressing it uses the first set of letters. You can think of the left pinky key as meaning "queenside", and not pressing it gives you kingside files.

The rest of the right hand is responsible for the rank. It works much the same as the files. You can think of the right pinky key as meaning black, and not pressing it gives you the white ranks.

If at any point you make a mistake, backspace is mapped to fe43

Castling

Kingside castling is done by pressing king + rook. Queenside castling is done by pressing king + rook + left pinky (the queenside key)

Underpromotion

If you want to underpromote a pawn, you need to press the file that the pawn is on, 43, and then the piece you want to underpromote to. If you're playing as black, you need to press the right pinky.

Same square

Sometimes two of the same piece will be controlling one square. In these cases you'll need to type two chords. First press the piece + either the rank or file, then for your second chord press the location of the controlled square.

Installation

You'll need to install kanata, then download the liboard.kbd file from this repo. Put both kanata and liboard into the same folder, cd into that folder, and run the following command:

$ sudo kanata -c liboard.kbd`

If you don't want to use sudo, see here.

Closing the terminal will exit kanata and restore your keyboard to its default state. You can set up a systemd process to make it permanent.

A note on lichess rules

According to lichess rules, it is prohibited to use "any program or browser extension that assists with playing moves". This rule is fairly broad, and could be interpreted to apply to custom keyboard layouts as well.

Ultimately, the purpose of this custom keyboard is to improve the ergonomics of playing chess online. For many people, using a mouse is not possible, and having a keyboard that reduces movement as much as possible makes online chess more accessible for people who otherwise could not play. However, because lichess rules are open to interpretation, please keep in mind that the use of this keyboard may not be allowed. Use your own judgement.

Examples

e4 nc3 qh5 o-o o-o-o g8=n

liboard's People

Contributors

clemenpine avatar

Watchers

 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.