このドキュメントではHerokuを用いて、無料で独自ダイスボット入りのBCDice-APIサーバーの建て方を解説します。ツールの制約により、コマンドラインを用いる必要があるため中級者向けの資料となっています。
この文書はHerokuの無料プランを利用することを想定して書かれましたが、無料プランは2022年11月から廃止されました。
- コマンドラインが使える
- Gitを使ったことがある/使えるようになる
- 英語のWebサイトで怯まない
- Herokuのアカウント登録
- Heroku CLIでの認証
- BCDice-APIの修正
- 独自ダイスボットを記述したコードの追加
- commit
- Herokuにデプロイ
HerokuはクラウドプラットフォームやPaaSと呼ばれるもので、VPSと比べてアプリケーションの設置や管理を容易に行うことができます。
Herokuでは無料プランが用意されており、独自サーバーを試しやすくなっています。
Herokuでは動作させるアプリケーションをGitで管理・送信する必要があり、このドキュメントでもGitを用います。
はじめに、このドキュメントで使うツールを列挙します。
- コマンドライン
- Git
- GitHub
- Heroku
- Heroku CLI
コマンドラインを用いてアプリケーションの設置を行います。 残念ながら、ドキュメント執筆時点ではコマンドラインを用いずにHerokuへBCDice-APIを設置することができません。
Herokuにアプリケーションを設置するにはアカウントが必要です。 下記リンクからアカウント登録を行ってください。
下記ドキュメントを参考に、Heroku CLIおよびGitのインストールを行ってください。
Heroku CLIをインストールしたら、ログインを行います。 コマンドラインで以下のように入力し、表示される指示に従ってログインします。
heroku login
BCDice-APIでは plugins/ にコードをいれておくと、読み込むようになっています。
BCDiceにないゲームシステムに対応するには、この機能を活用します。
まず、BCDice-APIをcloneします。
git clone https://github.com/ysakasin/bcdice-api
Cloneしたファイルの中にある plugins/ ディレクトリにダイスボットのコードをいれておきます。
そして、下記コマンドで変更を確定(commit)させます。
git add plugins/
git commit
ここまでで独自ダイスボットを内臓したBCDice-APIを手元に構築できました。
bcdice-api のディレクトリにいる状態で、以下のコマンドでHeroku上に場所を確保します。この時、 https://thawing-inlet-61413.herokuapp.com/ のように、このアプリのURLが表示されるのでメモしておきましょう。
heroku create
上記の作業で手元のgitリポジトリに、herokuというリモートが追加されています。
これにpushするとアプリケーションをHerokuにデプロイでいます。
pushは以下のようにして行います。
git push heroku master
これで独自サーバーの設置が完了です。 先ほどメモしたURLにブラウザからアクセスして、以下のように表示されればOKです。
Hello. This is BCDice-API.
GitHub issuesや私のTwitterに困っていることを教えてください。 可能な限りサポートします。
2019年現在、様々なオンセツールが有志によって開発されており、その多くが無料で使うことができます。 このBCDice-APIも、たいたい竹流さんが作成したBCDiceを用いております。 気に入ったツールがあれば、Amazonギフト券等の支援をぜひお願いいたします。 ツール開発の励みになることと思います。