はじめに

これはDiscord APIを利用したアプリケーションを作成するのに便利なPythonライブラリ、ndiscord.pyのドキュメントです。

前提

ndiscord.py は Python 3.8 以降で動作します。以前のバージョンの Python に対するサポートは提供されていません。 Python 2.7 以下はサポートされていません。Python 3.7 以下はサポートされていません。

インストール

このライブラリは、開発バージョンを使用してのみインストールできます:

python3 -m pip install -U git+https://github.com/naoTimesdev/ndiscord.py

手動でクローンする:

git clone https://github.com/naoTimesdev/ndiscord.py
cd ndiscord.py
python3 -m pip install -U .

音声のサポートが必要な場合は、 discord.py ではなく、以下の例のように discord.py[voice] を使うべきです。

python3 -m pip install -U git+https://github.com/naoTimesdev/ndiscord.py[voice]

Linux環境では、依存関係にある以下のライブラリが必要になるので注意してください。

Debianベースのシステムでは、次のコマンドで依存関係にあるライブラリを取得できます。

$ apt install libffi-dev libnacl-dev python3-dev

自分の権限の確認は忘れないようにしてください！

仮想環境

システムへのインストールをライブラリによって汚したくない場合や、現在インストールされているシステムとは異なるバージョンのライブラリを使用したい場合があります。または、システムへのライブラリのインストール権限がない場合などです。こういった目的のため、Python3.3の標準ライブラリには、このように別々のバージョンを保持したい場合のために、「仮想環境」というものが用意されています。

より詳しいチュートリアルは Virtual Environments and Packages にあります。

簡単に仮想環境を構築する方法。

  1. プロジェクトの作業ディレクトリに移動してください。

    $ cd your-bot-source
$ python3 -m venv bot-env

  2. 下記コマンドで仮想環境を有効化します。

    $ source bot-env/bin/activate

    Windowsの場合は、こちらを使ってください。

    $ bot-env\Scripts\activate.bat

  3. いつものようにpipインストールを実行します。

    $ pip install -U git+https://github.com/naoTimesdev/ndiscord.py

おめでとうございます。これで仮想環境のセットアップができました。

基本概念

ndiscord.pyは イベント の概念を中心としています。イベントは何かを受け取り、それに対する応答を行います。例えば、メッセージが発生すると、メッセージの発生に関連するイベントを受け取り、そのイベントに対して応答を返すことができます。

以下はイベントの仕組みを紹介する簡単な例です。

import discord

class MyClient(discord.Client):
    async def on_ready(self):
        print(f'Logged on as {self.user}!')

    async def on_message(self, message):
        print(f'Message from {messsage.author}: {message.content}')

client = MyClient()
client.run('my token goes here')