o-jill / jkf

JSON棋譜フォーマット(JKF)の定義とKIF, KI2, CSAからの変換ライブラリ

Jkf

jkfはJSON棋譜フォーマット( https://github.com/na2hiro/json-kifu-format )をRubyに移植したものです。 KIF, KI2, CSAをパースしJKFへ変換、JKFからKIF, KI2, CSAへの変換に対応しています。

Installation

アプリケーションにインストールする場合(bundlerを使用する場合)、Gemfileに以下のように記述してください。

gem 'jkf'

さらにbundleコマンドを実行することでインストールできます。

$ bundle

または、gem installコマンドを使って直接インストールすることもできます。

$ gem install jkf

Usage

KIF, KI2, CSAそれぞれParserとConverterが用意してあります。

kif_parser = Jkf::Parser::Kif.new
ki2_parser = Jkf::Parser::Ki2.new
csa_parser = Jkf::Parser::Csa.new

kif_converter = Jkf::Converter::Kif.new
ki2_converter = Jkf::Converter::Ki2.new
csa_converter = Jkf::Converter::Csa.new

parser#parse(str)でjkfへの変換、#convert(jkf)でjkfから各フォーマットへ変換できます。

jkf = kif_parser.parse(kif_str) #=> Hash
jkf = ki2_parser.parse(ki2_str) #=> Hash
jkf = csa_parser.parse(csa_str) #=> Hash

kif = kif_converter.parse(jkf) #=> String
ki2 = ki2_converter.parse(jkf) #=> String
csa = csa_converter.parse(jkf) #=> String

Contributing

バグレポートやプルリクエストはGithubでよろしくお願いします。 https://github.com/iyuuya/jkf.

License

ライセンスはMITです。 MIT License.