意外と簡単だったからDiscordのBOTを作ってみるよ

2018-01-23その他Python, Discord

どうも、久しぶりの技術系の記事です。またしても、学生としてやるべきことを放置してこちらの記事を書いていきます。というのも、最近なにかとDiscordを使う機会が増えたのですが、とあるサーバーでみたBOTの働きが面白くて、作りたくなってしまいました。

というわけで、今回はDiscordのBOT作りの第一歩として、簡単な返答BOTを作っていこうと思います。今回はPythonの3.6.x系で開発していきますが、Pythonの環境構築は本記事では触れないので、こちらの記事(Ubuntu, MacOS)なんかを参考に構築しておいてください。

OS : Ubuntu 16.04 LTS, MacOS
Python : 3.6.0

Contents

1. 環境構築

さて、まずは環境構築です。今回はDiscordのAPIをPythonから動作させたいので、”Discord.py“というものを使っていきます。基本的には公式のGitHubに書かれている導入方法を参考にすれば簡単にインストールできると思います。

というわけで、以下のコマンドでインストールします。

$ python3 -m pip install -U discord.py

1	$ python3 -m pip install -U discord.py

基本的には上記のコマンドで十分ですが、もし開発版が欲しかったりコンパイルがしたい場合は、適宜GitHubのページを確認して適切なコマンドを選択してください。

2. BOTの登録

次に、DiscordのディベロッパーページからBOTを実行するときに使用するトークンを取得してきます。というわけでまずは以下のページにアクセスしてください。

Discord

Discord API Docs for Bots and Developers

https://discordapp.com/developers/applications/me

Integrate your service with Discord - whether it's a bot or a game or your whatever you wildest imagination can come up with.

画面が表示されたら、”New App”を選択して新しいアプリを登録していきます。するとアプリ情報の入力フォームが出てくるので、対応する情報を入力していきます。ちなみに、後からいくらでも変更できるので、動作テストするだけなら本気で考えなくてもいいと思います。

“APP NAME” : アプリ名テケトーで大丈夫
“REDIRECT URI(S)” : 操作不要
“APP DESCRIPTION” : 説明、テケトーで大丈夫
“APP ICON” : アイコン操作不要

アプリの登録が完了したら、次にアプリにBOT機能を持たせるための操作をやっていきます。アプリの登録が完了したあとに出てくるページ(そのアプリのメインページ)の下の方に以下の画像のようなところがあると思います。

この中の右側にある”Create a Bot User”を押します。すると”ADD A BOT TO THIS APP?”というモーダルがでてくるので”Yes, do it!”を押して完了です。すると先ほどの画像のような箇所がBOTの設定を行える感じになります。今回は特に操作する必要はないので、そのままにしておきます。

ただ、BOTの実行時に使用するトークンを取得しなくてはいけません。トークンはいま操作していた箇所にある”Token:click to reveal”という小さい文字をクリックすることで見ることができます。ここで表示される文字列は他の人には秘密ですが、後で使うのでメモしておいてください。

3. サーバーに登録

次に、Discordに作っておいた自分のサーバーにBOTを参加させます。サーバーの作成についてはこちらなんかを参考にしてみてください。

サーバーにBOTを参加させるには、アプリのメインページにある”Generate OAuth2 URL”を押します。すると以下の画像のような画面が表示されます。

表示されたら”SCOPES”で”BOT”が選択されていることと”Bot Permissions”で適切なパーミッションが設定されていることを確認してください。今回はコメントに返答するだけなので特に設定する必要はないみたいです。もし設定が必要になったら公式のリファレンスを確認しつつ設定してください。めんどくさかったら”Administrator(管理者)”とかでもいいのでは…外部に公開しなければ。

Discord

Discord API Docs for Bots and Developers

https://discordapp.com/developers/docs/topics/permissions

Integrate your service with Discord - whether it's a bot or a game or your whatever you wildest imagination can come up with.

確認が終わったら、さきほどの画像でいうところの真ん中にあるURLをコピーして、そのアドレスにアクセスします。するとBOTを追加するサーバーが問われるので、参加させたいサーバーを選択しておしまいです。これだけでサーバにBOTが参加しました。

4. プログラムを書く

さて、ここまで来たらあとはプログラムを書いて実行するだけです。プログラムのサンプルはこれまた公式GitHubにあるので、ただ動かしたい人はそちらでも大丈夫です。本記事では単純にコメントに返答するBOTのコードをコメント増し増しで掲載しておきます。

#coding: utf-8

# 上記で取得したアプリのトークンを入力
BOT_TOKEN = "************************.******.***************************"

# パッケージのインポートとインスタンス作成
import discord
client = discord.Client()

# ログイン&準備が完了したら一度だけ実行される
@client.event
async def on_ready():
    # コンソールにBOTとしてログインした名前とUSER-IDを出力
    print('Logged in as')
    print('BOT-NAME :', client.user.name)
    print('BOT-ID   :', client.user.id)
    print('------')

# メッセージを受信するごとに実行される
@client.event
async def on_message(message):

    # BOTとメッセージの送り主が同じ人なら処理しない
    if client.user == message.author:
        return

    # メッセージの頭が "!hello" なら実行する
    if message.content.startswith('!hello'):
        # メッセージが送られてきたチャンネルに "Hello World..." を返す
        await client.send_message(message.channel, 'Hello World...')

# APP(BOT)を実行
client.run(BOT_TOKEN)