Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 3.23 KB

File metadata and controls

84 lines (56 loc) · 3.23 KB

BCDice-API

BCDiceを提供するWebAPIサーバー

Build Status

Demo

https://bcdice.herokuapp.com

What is BCDice

BCDiceは日本のTRPGセッションツールにおいて、デファクトスタンダードとも言えるダイスロールエンジンです。 初めは、Faceless氏によってPerlを用いて作成されました。後に、たいたい竹流氏によってRubyへの移植され、現在までメンテナンスされています。

BCDiceはどどんとふをはじめとして、TRPGオンラインセッションSNSOnset!においてダイスロールエンジンとして使われています。

Setup

$ git clone https://github.com/ysakasin/bcdice-api.git
$ cd bcdice-api
$ git checkout `git describe --abbrev=0` #直近のリリースに移動
$ git submodule init
$ git submodule update
$ bundle install

Run

Development

$ bundle exec rackup

Production

$ APP_ENV=production bundle exec rackup -E deployment

実際に運用する場合には、Pumaの利用をお勧めします。

公開サーバーとして運用する場合、 /v1/admin の情報を設定するようにしてください。

API

Method Description
/v1/version BCDiceとAPIサーバーのバージョン
/v1/admin APIサーバ提供者の名前と連絡先
/v1/systems ダイスボットのシステムID一覧
/v1/names ダイスボットのシステムIDとシステム名前の一覧
/v1/systeminfo ダイスボットのシステム情報取得
/v1/diceroll ダイスボットのコマンドを実行

Plugin

plugins/ ディレクトリにダイスボットのコードを入れておくと、サーバー起動時にロードし、使うことができます。 既存のダイスボットを上書きすることもできます。

Documents

Cases

Donate

The Auther

酒田 シンジ (@ysakasin)