didyoumean-discordpy's Introduction

didyoumean-discordpy

description

discord.pyのcommandsフレームワークの拡張ライブラリです。
画像のように、間違ったコマンドを打ったとき、似たコマンドが見つかった場合にそのコマンドを表示させることができます。

デフォルトでは3件まで似たコマンドを表示させることができます。

how to use

インストール
- python3 -m pip install didyoumean-discordpy
- (Windowsの場合)py -3 -m pip install didyoumean-discordpy

拡張機能として追加
例:

bot.load_extension("didyoumean-discordpy")

これだけで利用することができます。

modding

このライブラリでは、

似たコマンドの最大表示数
似たコマンドを表示させるときのメッセージを変更することができます。

set max suggest

DidYouMean.max_suggestに最大表示数となる値を代入してください。
例:

bot.get_cog("DidYouMean").max_suggest = 2

change message generator

まず、MessageGeneratorを継承したクラスを作成してください。
sendメソッドをオーバーライドすることで自分好みのメッセージを出すことができます。その後、DidYouMean.set_message_generatorを使用して自作したメッセージジェネレータを登録します。
例:

from didyoumean-discordpy.message_generator import MessageGenerator

class MyMessageGenerator(MessageGenerator):
    async def send(self, ctx):
        # do something...


bot.get_cog("DidYouMean").set_message_generator(MyMessageGenerator)