https://github.com/nozaq/usi-run

A command line utility for running games between USI compliant Shogi engines.
https://github.com/nozaq/usi-run

board-game cli engine rust shogi usi

Last synced: 2 months ago
JSON representation

A command line utility for running games between USI compliant Shogi engines.

• Host: GitHub
• URL: https://github.com/nozaq/usi-run
• Owner: nozaq
• License: mit
• Created: 2017-02-21T12:50:45.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2023-11-25T09:22:34.000Z (about 1 year ago)
• Last Synced: 2024-04-25T20:20:15.536Z (8 months ago)
• Topics: board-game, cli, engine, rust, shogi, usi
• Language: Rust
• Homepage:
• Size: 72.3 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# usi-run

[![Github Actions](https://github.com/nozaq/usi-run/workflows/build/badge.svg)](https://github.com/nozaq/usi-run/actions?workflow=build)

[![Coverage Status](https://coveralls.io/repos/github/nozaq/usi-run/badge.svg)](https://coveralls.io/github/nozaq/usi-run)

[![crates.io](https://img.shields.io/crates/v/usi-run.svg)](https://crates.io/crates/usi-run)

A command line utility for automatically running games between USI compliant Shogi engines and collect match statistics.

Tested with popular USI engines, e.g. [Apery](https://github.com/HiraokaTakuya/apery), [Gikou(技巧)](https://github.com/gikou-official/Gikou), [YaneuraOu(やねうら王)](https://github.com/yaneurao/YaneuraOu).

## Installing

`usi-run` can be installed from Cargo.

```sh

$ cargo install usi-run

```

## Usage

```text

A command line utility for running games between USI compliant Shogi engines.

USAGE:

    usirun [OPTIONS] --config 

FLAGS:

    -h, --help       Prints help information

    -V, --version    Prints version information

OPTIONS:

    -c, --config      Loads a configuration file for setting up match rules

    -d, --display     Displays  [default: simple]  [values: board, csa, command, simple]

```

A configuration file looks like the following. See [example.toml](https://github.com/nozaq/usi-run/blob/master/example.toml) for more detail.

```toml

num_games = 10

max_ply = 256

[time_control]

black_time = 60000w

white_time = 60000

black_inc = 10000

white_inc = 10000

[black]

engine_path = "/path/to/executable"

working_dir = "/path/to/dir"

ponder = false

    [black.options]

    USI_Hash = 128

    Threads = 1

[white]

engine_path = "/path/to/executable"

working_dir = "/path/to/dir"

ponder = false

    [white.options]

    USI_Hash = 128

    Threads = 1

```