bcdice-api's Introduction

BCDice-API

BCDiceを提供するWebAPIサーバー

Public servers

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

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

What is BCDice

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

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

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 の情報を設定するようにしてください。

/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

Herokuで独自ダイスボット入りのBCDice-APIサーバーを立てる (中級者向け)

Cases

discord-bcdicebot
Line botでダイスを振る - Qiita
HTTPS版BCDice-API | 大ちゃんのいろいろ雑記 : どどんとふ公式鯖による公開サーバー
オンラインセッションツール – Hotch Potch . : えいむ氏による公開サーバー

Donate

The Auther

酒田　シンジ (@ysakasin)

bcdice-api's People

Contributors

Stargazers

Watchers

bcdice-api's Issues

不正なコマンドを受け取った際のエラーハンドリング

どどんとふ公式鯖で受け取っているDiceBotのかなりの数が、Command=部分に普通のチャットメッセージ等が挿入されていて、その際に「NoMethodError - undefined method `gsub' for nil:NilClass:」や「CommandError - CommandError:」のExceptionのログが大量に吐かれてしまいます。
API的には400を返して終わりなので利用者や開発者側から気がつくことなくサーバー側にかなりの量のログが溜まってしまうので、この部分のエラーをTRAPするようにする等はできないでしょうか？

Setupの方法について、Readmeの更新提案

はじめまして。初issueゆえ拙い部分があると思われますが、ご指摘頂けると助かります。
まとめると、Readmeの
`$ bundle exec rackup`
を
`$ bundle exec rackup -o 0.0.0.0`
に差し替える提案についてです。

自宅のCentos7サーバにLAN内のWindows10マシンから遠隔で配置を試みまして、Setupの最後の部分で詰まっていました。
$ bundle exec rackup
この通りにコマンドを入力するとLAN内外問わず接続ができない状態でした。このとき他のサービスは通常通り使えています。
調べましたところ、このようなページがヒットしました。
sinatraでrackupからの起動でlocalhost以外からの接続を許可しようとしたらハマった件
このページの通りに先程のコマンドを
$ bundle exec rackup -o 0.0.0.0
と置き換えて実行したところ、無事LAN内外問わず動作していることを確認できました。
今はサービス化まで済ませています。
よろしくおねがいします。

Recommend Projects

bcdice / bcdice-api Goto Github PK