Kami Chess 1.0.0
====================

Chess on a 3D board with boxwood and walnut pieces. Play a friend at the same
computer, or play against the computer.


Start
-----

Unpack the archive anywhere and run the program from the folder it made:

    tar -xzf kami-chess-1.0.0-linux-x86_64.tar.gz
    ./kami-chess-1.0.0/kami-chess

Nothing is installed. The program finds its board and pieces in the assets
folder beside it, so keep the folder together; to remove the game, delete it.

    ./kami-chess                                     two players at one computer
    ./kami-chess --opponent black                    you play white, the computer black
    ./kami-chess --opponent white                    the computer moves first
    ./kami-chess --opponent black --depth 6 --time-ms 3000
                                                     the computer thinks longer


Options
-------

  --opponent none|white|black   The side the computer plays. Default none: two
                                players. Otherwise you play the other side.
  --depth N                     How many half-moves ahead the computer looks,
                                1 to 64. Default 4.
  --time-ms N                   How long the computer may think, in
                                milliseconds, before it plays its best move so
                                far. Default 1000; 0 means no limit.
  --fen FEN                     Start from a position written in FEN instead of
                                the start position.
  --width N, --height N         The window size. Default 1280 x 960. The window
                                can also be resized.
  --help, --version             Print the options, or the version.

While the computer thinks, a pulsing blue strip lights its half of the board
frame and the board ignores your clicks.


Controls
--------

  Click a piece, then a      Move. A pawn reaching the last rank opens a choice
  highlighted square         of four pieces on the board.
  Drag with the left button  Turn the camera around the board.
  Mouse wheel                Zoom.
  f                          Turn the camera to the other player's side.
  r                          Reset the camera.
  u                          Undo. Against the computer it takes back its reply
                             and your move.
  Esc                        Deselect, or close the promotion choice.
  q r b n                    Choose the promotion piece while the choice is open.
  Ctrl+Q                     Quit.


Requirements
------------

  - 64-bit Linux on x86-64 with glibc 2.38 or newer (for example Ubuntu 24.04,
    Debian 13, Fedora 39 or later).
  - A desktop session, X11 or Wayland.
  - OpenGL 3.3 graphics with the GLVND libraries libOpenGL.so.0 and
    libEGL.so.1, which current graphics drivers install (on Debian and Ubuntu
    the packages libopengl0 and libegl1).

The C++ runtime is built in; nothing else is needed.


Licences
--------

THIRD-PARTY-NOTICES.txt holds the licences of the libraries built into the
program.
