Skip to content

Latest commit

 

History

History
377 lines (299 loc) · 7.48 KB

MANUAL.md

File metadata and controls

377 lines (299 loc) · 7.48 KB

cboard(1) - Simple chess game editor

cboard [OPTIONS] [PGN_FILE]

Description

cboard is chess game editor done with SDL.

It is designed to be controlled by keyboard using different modes. Current mode is shown in lower left corner. See MODES

Options

  • -c, --config file
    Path configuration file.
  • -f, --font file
    Path to TrueType font file.
  • --FEN-start
    Starting position in FEN format.
  • --FEN-find
    Set current move for position in FEN format.
  • -h, --help
    Prints usage information.
  • -n, --number number
    Game number (starting from 0).
  • -o, --output format
    Output format (default none). Supported formats are: FEN, PGN.
  • -p, --pieces dir
    Path to directory containing images of pieces, named with lowercase first character of color and piece. Example: black bishop = bb.png
  • -v, --version
    Prints version.

Modes

NORMAL

Main mode, other modes are entered from here.

  • q
    Quit.
  • g
    Enter GAME_LIST mode.
  • G
    Toggle Game list statistics.
  • e
    Enter EDIT mode.
  • f
    Enter FILENAME mode.
  • n
    Enter NUMBER mode.
  • s
    Enter SAN mode.
  • t
    Enter TAG mode.
  • T
    Enter TRAINING mode.
  • v
    Enter MOVE mode.
  • V
    Enter POSITION mode.
  • a
    Enter COMMENT mode after current move.
  • A
    Enter COMMENT mode before current move.
  • c
    Enter CLIPBOARD mode.
  • r
    Rotate chessboard.
  • W
    Write current game.
  • m
    Start/stop machine 1.
  • M
    Start/stop machine 2.
  • b
    Show/hide machine output.
  • Space
    Play best move from machine 1.
  • Shift-Space
    Play best move from machine 2.
  • o
    Start/stop explorer 1.
  • O
    Start/stop explorer 2.
  • 0-9
    Explorer events.
  • l, Arrow Right, Mouse Scroll Up
    Go to next move.
  • h, Arrow Left, Mouse Scroll Down
    Go to previous move.
  • j, Arrow Down
    Go to first sub variation.
  • k, Arrow Up
    Go to parent variation.
  • L, Shift-Arrow Right
    Go to last move.
  • H, Shift-Arrow Left
    Go to first move.
  • J, Shift-Arrow Down
    Go to next sub variation.
  • K, Shift-Arrow Up
    Go to previous sub variation.
  • u
    Undo last destructive operation.
  • Ctrl-r
    Redo last destructive operation.
  • z
    Increase size of chessboard.
  • Z
    Decrease size of chessboard.
  • p
    Promote current variation.
  • P
    Promote current variation and delete old.
  • i Insert moves from parent variation to current variation until they are valid.
  • d
    Delete current variation.
  • D
    Delete remaining moves after current move.
  • PageUp, Ctrl-u
    Scroll notation up.
  • PageDown, Ctrl-d
    Scroll notation down.

GAME_LIST

  • q
    Quit.
  • Escape
    Return to NORMAL mode.
  • Return
    Read current game.
  • r
    Read reversed game list from file.
  • R
    Read game list from file.
  • p
    Search current position.
  • j, Arrow Down
    Move to next game.
  • k, Arrow Up
    Move to previous game.
  • /
    Enter TEXINPUT search mode.
  • c
    Insert game title in comment after current move.
  • PageUp, Ctrl-u
    Scroll game list up.
  • PageDown, Ctrl-d
    Scroll game list down.

TEXTINPUT

Pressed keys are inserted as text.

  • Escape
    Return to previous mode.
  • Ctrl-u
    Delete all text.
  • Left Arrow
    Move cursor left.
  • Right Arrow
    Move cursor right.
  • Backspace
    Delete character before cursor.
  • Delete
    Delete character after cursor.

EDIT

  • Mouse Click Left
    Insert current piece at clicked square.
  • Mouse Click Right
    Clear piece at clicked square.
  • q
    Quit.
  • c
    Clear board.
  • s
    Set starting position.
  • f
    Import FEN from clipboard.
  • r
    Rotate chessboard.
  • 0
    Change color.
  • 1
    Select pawn of current color.
  • 2
    Select knight of current color.
  • 3
    Select bishop of current color.
  • 4
    Select rook of current color.
  • 5
    Select queen of current color.
  • 6
    Select king of current color.

FILENAME

TEXTINPUT mode. Filename is used for reading and writing.

NUMBER

TEXTINPUT mode. Number represents game sequence. If value is "a" game is added at the end of file.

SAN

It is TEXINPUT mode. Correct SAN moves are accepted and played.

  • Return
    If move is correct it is played.

TAG

TEXTINPUT mode. First the tag name is inputted. If it already exists, it will be edited - otherwise new tag is created.

  • Return
    Confirm tag name. And enter TEXTINPUT mode for editing tags. Tag will be removed it its value is empty string (except for required 7 tags).

TRAINING

TEXTINPUT mode. Notation is hidden. After user plays move that exists in notation the opponents move will be played automatically - starting with main line. Move can be inserted with mouse or in SAN format. There are 3 avaliable commands besides correct SAN moves: Restart, Repeat and Next. Restart will start from begining - first game and its main line. Repeat will replay current line again. Next will proceed to the next line or next file if all lines in current game are finished.

MOVE

Move annotation.

  • q
    Quit.
  • r
    Rotate chessboard.
  • j, Arrow Down
    Select next move NAG.
  • k, Arrow Up
    Select previous move NAG.
  • x, Backspace
    Delete move NAG.
  • Escape
    Return to NORMAL mode.

POSITION

Position annotation.

  • q
    Quit.
  • r
    Rotate chessboard.
  • j, Arrow Down
    Select next position NAG.
  • k, Arrow Up
    Select previous position NAG.
  • x, Backspace
    Delete position NAG.
  • Escape
    Return to NORMAL mode.

COMMENT

TEXTINPUT mode. Comment is inserted after/before current move.

CLIPBOARD

  • q
    Quit.
  • f
    Copy current FEN to clipboard.
  • Escape
    Return to NORMAL mode.

Explorer

Explorer is external program that comunicates with cboard over standard input and output.

COMMANDS

Commands are send from cboard to explorer.

  • fen string
    Current position in cboard.

RESPONSE

Explorer should return newline separated strings. Response will be shown in cboard without modification.

Configuration

Configuration is done by line separated key=value. Lines starting with # are skipped. Example config is located in /usr/share/cboard/config.

  • machine_1_exe, machine_2_exe
    Absolute path to engine executable. machine_1_exe=/bin/stockfish
  • machine_1_param,machine_2_param
    Engine command line parameters, can be used multiple times. machine_2_param=--logfile=/home/user/log
  • machine_1_uci_option_start, machine_2_uci_option_start
    Option does not take value. Lines after this are passed to engine.
  • machine_1_uci_option_end, machine_2_uci_option_end
    End literal input.
  • explorer_1_exe,explorer_2_exe
    Absolute path to explorer executable.

Files

$HOME/.config/cboard/config Default config location.