# shogi-kifu-converter

[![Crates.io](https://img.shields.io/crates/v/shogi-kifu-converter)](https://crates.io/crates/shogi-kifu-converter)
[![docs.rs](https://img.shields.io/docsrs/shogi-kifu-converter)](https://docs.rs/shogi-kifu-converter)
[![Crates.io](https://img.shields.io/crates/l/shogi-kifu-converter)](https://opensource.org/licenses/MIT)
[![Rust](https://github.com/sugyan/shogi-kifu-converter/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/sugyan/shogi-kifu-converter/actions/workflows/rust.yml)

A Rust library that defines structs compatible with [json-kifu-format](https://github.com/na2hiro/json-kifu-format), containing parsers and converters for Shogi kifu (game record) for converting to and from json-kifu-format. And, it also provides conversion from `JsonKifuFormat` type to [`shogi_core`](https://crates.io/crates/shogi_core)'s `Position` type.

```mermaid
flowchart LR;
    JKF((json-kifu-format))
    CSAin[CSA formatted kifu] -->|parse| JKF;
    KIFin[KIF formatted kifu] -->|parse| JKF;
    KI2in[KI2 formatted kifu] -->|parse| JKF;
    JSON[JSON] -->|parse| JKF
    JKF -->|write| CSAout[CSA formatted kifu]
    JKF -->|write| KIFout[KIF formatted kifu]
    JKF -->|write| KI2out[KI2 formatted kifu]
    JKF -->|write| USIout[USI position data]
    JKF <-.->|std::convert| Core(shogi_core::Position)
```

## About json-kifu-format (JKF)

See [github.com/na2hiro/json-kifu-format](https://github.com/na2hiro/json-kifu-format).

## Supporting formats and types

### Parsers

- [CSA format](http://www2.computer-shogi.org/protocol/record_v22.html)
- [KIF format](http://kakinoki.o.oo7.jp/kif_format.html)
- [KI2 format](http://kakinoki.o.oo7.jp/KifuwInt.htm)

### Converters

- [`ToUsi`](https://docs.rs/shogi-kifu-converter/latest/shogi_kifu_converter/jkf/struct.JsonKifuFormat.html#impl-ToUsi-for-JsonKifuFormat)
- [`ToCsi`](https://docs.rs/shogi-kifu-converter/latest/shogi_kifu_converter/jkf/struct.JsonKifuFormat.html#impl-ToCsa-for-JsonKifuFormat)
- [`ToKif`](https://docs.rs/shogi-kifu-converter/latest/shogi_kifu_converter/jkf/struct.JsonKifuFormat.html#impl-ToKif-for-JsonKifuFormat)
- [`ToKi2`](https://docs.rs/shogi-kifu-converter/latest/shogi_kifu_converter/jkf/struct.JsonKifuFormat.html#impl-ToKi2-for-JsonKifuFormat)
- [`TryFrom<&jkf::JsonKifuFormat> for shogi_core::Position`](https://docs.rs/shogi-kifu-converter/latest/shogi_kifu_converter/jkf/struct.JsonKifuFormat.html#impl-TryFrom%3C%26JsonKifuFormat%3E-for-Position)

### Examples

See [`examples`](https://github.com/sugyan/shogi-kifu-converter/tree/main/examples) directory.