Chess++

A chess UCI adapter. Provides an easy to use API for consuming and producing UCI commands.

NOTE: This Library is still under development and not at all ready for use. Contributions are welcome!!!

Table of Contents

1. Getting Started
   1. Installation
   2. Usage
      1. Register Command
      2. Issue Command
      3. Start

Getting Started

Installation

The package can be build most easily using cmake:

add_subdirectory(/path/to/Chess++)
target_link_libraries(My_project PUBLIC
    Chess++
    ...
)

Usage

Register Command

To tell the UCI what to do when it recieves a command on standard input we simply have to pass it the callback we would like to run:

#include <vector>

#include "chesspp/uci.hpp"
#include "chesspp/argument.hpp"


void debug_command(std::vector<chesspp::Argument> args){
    if(args[0].value == "on") {
        // switch debugging on
    } else {
        // switch debugging off
    }
}

int main()
{
    chesspp::UCI uci;
    // Register debug_command with the UCI
    uci.register_command("debug", debug_command);
    return 0;
}

Issue Command

To issue a command just tell the UCI the name of the command followed by a vector containing any arguments:

#include <vector>

#include "chesspp/uci.hpp"

int main(){
    chesspp::UCI uci;
    std::vector<string> arguments = {"on"};
    uci.issue_command("debug", arguments);
    return 0;
}

The UCI will now make sure that the command is valid before issuing it.

Start

To tell the UCI to start listening for commands we just call the start function along with the mode ("engine" or "interface"):

#include "chesspp/uci.hpp"

int main(){
    chesspp::UCI uci;
    uci.start("engine"); // Start listening for commands issued to the engine from the interface
    return 0;
}