Skip to content

bcdice/bcdice-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6520d34 · Feb 13, 2024
Feb 13, 2024
Feb 13, 2024
Mar 25, 2020
Feb 13, 2024
Feb 13, 2024
Apr 13, 2020
Feb 13, 2024
Feb 3, 2021
Mar 25, 2020
Jul 9, 2019
Feb 13, 2024
Feb 13, 2024
Feb 13, 2024
Feb 13, 2024
Feb 13, 2024
Feb 13, 2024
Feb 2, 2017
Jul 2, 2017
Feb 13, 2024
Dec 28, 2020
Jan 1, 2021
Jan 1, 2021

Repository files navigation

BCDice-API

BCDiceを提供するWebAPIサーバー

Action Status Docker repository

Public servers

有志によって運営されている公開サーバーの一覧

https://api-status.bcdice.org/

What is BCDice

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

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

Setup

$ git clone https://github.com/bcdice/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の利用をお勧めします。

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

API

/v2

Method Description
/v2/version BCDiceとAPIサーバーのバージョン
/v2/admin APIサーバ提供者の名前と連絡先
/v2/game_system ゲームシステムの一覧
/v2/game_system/{id} ゲームシステムの情報
/v2/game_system/{id}/roll ダイスロール
/v2/original_table オリジナル表の実行

Plugin

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

Documents

Cases

Donate

The Auther

酒田 シンジ (@ysakasin)