チュートリアル
想定
Node.js:v11.12.0以上
npm:6.9.0以上
yarn:1.0.0以上
Step. 1「ボットのフォルダを用意しよう」
フォルダを作成しましょう。
名前はBiscoTutorialBotにしてください。
Step. 2「npmでフォルダを初期化しよう」
作成したフォルダ内でnpm init -yを実行して初期化してください。
Step. 3「biscoをインストールしよう」
同じようにフォルダ内でyarn add biscoを実行してbiscoをインストールしてください。
Step. 4「bot.jsを作成しよう」
フォルダ内にbot.jsというファイルを作成してください。
作成したら以下のコードを書き、保存してください。
code:JavaScript
const Bisco = require('bisco')
const bot = new Bisco('ボットトークン') // 各自ボットのトークンを入れてください。
bot.setPrefix('!') // コマンドの接頭辞です。!だと!コマンドになります。
bot.setVersionString('0.0.0') // ボットのバージョンを文字列で指定します。
bot.onReady(() => {
// この関数はボットがログインに成功すると実行されます。
console.log(${bot.client.user.tag}としてログインしました。)
})
// ここからコマンド
// ここまでコマンド
bot.run() // ボットを起動します。
Step. 5「ボットを起動しよう」
フォルダ内でnode bot.jsを実行し、ボットを起動してください。
起動したらサーバー内で!helpを入力してください。
ヘルプが表示されるはずです。
https://gyazo.com/7192ef82806bce467c4ec81f32fd4efe
デフォルトだと以下のコマンドが実装されています。
help
ヘルプを表示します。
games
遊べるゲームの一覧を表示します。
games.rooms.count
現在アクティブになっているゲーム一覧を表示します。
Step. 6「randコマンドを実装しよう」
bot.jsの// ここからコマンドから// ここまでコマンドの間に以下のコードを書いてください。
code:JavaScript
// ここからコマンド
bot.command('rand({min}, {max})', (msg, { min, max }) => {
min = Number(min) // 数値に変換
max = Number(max) // 数値に変換
msg.reply(Bisco.Helpers.Random(min, max))
}).setDescription('minからmaxまでの乱数を返します。')
// ここまでコマンド
ボットが起動していたら再起動してボットを起動してください。
!helpを実行してrandのヘルプが表示されているか確認してください。
https://gyazo.com/bc4b63c37eb29651a49be53ad481d9cc
次に!rand(0, 10)を実行して確認してください。
https://gyazo.com/9baab8e674403f2b39d4d47ffd68fdab
Step. 6「解説」
bot.command関数はコマンドを定義する関数です。
引数は
パターン
文字列
{変数名}でキャプチャできる
処理
関数
引数にはmsgとキャプチャした変数を含むargsが渡される
bot.command(...).setDescription関数はコマンドの説明を設定する関数です。
この説明はヘルプで表示されます。
引数は
description
文字列
コマンドの説明に設定されます。
Bisco.Helpers.Randomは範囲内の乱数を返すヘルパー関数です。
引数は
min
数値
最小値
max
数値
最大値