当BOTは開発を終了しました。そのため、リポジトリをアーカイブ致します。
現神の聖遺物のスコアを計算して画像を生成する「ArtifacterImageGen」をDiscord用BOTとして利用できるようにするためのコードです。
私は「ArtifacterImageGen」を元に作成したDiscordBOTを誰でも簡単に使えるように、MITライセンスでコードを配布することにしました。
これは、「ArtifacterImageGen」がgithubでMITライセンスで配布されているおかげです。
Hyugoさんに心から感謝します。
また、「EnkaNetworkAPI」ライブラリがあることで、アセットの更新が容易になりました。
yuko1101に心から感謝します。
githubを使うのはほぼ初めてなので、間違い等あるかもしれません。
間違いがあればご連絡いただけると幸いです。
動作を確認したバージョンです。
これらのバージョンを使用しても環境によっては動作しない場合があります。
Python 3.9.2, 3.11.2, 3.12.1
Discord.py 2.2.2, 2.3.2
python-dotenv 1.0.0
Pillow 9.5.0, 10.0.1, 10.2.0
PyYAML 6.0, 6.0.1
requests 2.28.2, 2.31.0
Node.js 18.16.0, 20.10.0
npm 9.5.1, 10.3.0
/helpコマンドを実行して、コマンドに関する説明を見てください。
クリックして開く
DiscordDeveloperPortalにアクセスします。
https://discord.com/developers/applications
「New Application.」をクリックします。
(すでに専用BOTを作成している場合は、トークン生成まで読み飛ばしてください)
BOTの名称を決め、「NAME」欄に入力する。
利用規約とデベロッパーポリシーに同意し、「Create」をクリックします。
「SETTING」の「BOT」タブを選択し、「Add Bot」をクリックします。
確認ダイアログが表示されたら、「Yes, do it!」をクリックします。
(2FAが設定されている場合は、認証してください)。
「TOKEN」の下にある「Copy」をクリックして、BOTトークンをコピーします。
このトークンをメモ帳などにメモ（ペースト）しておく。
このトークンは、流出しないように注意してください。
「Privileged Gateway Intents」の「PRESENCE INTENT」、「SERVER MEMBERS INTENT」、「MESSAGE CONTENT INTENT」3つすべてをONにします。
変更を保存するには、忘れずに「Save Changes」をクリックしてください。
メニューから「OAuth2」→「URL Generator」を選択します。
「SCOPES」の「BOT」にチェックを入れ、「BOT PERMISSIONS」を必要なパーミッションに設定します。
(サーバーを所有し、本ボットのコードを信頼している場合は、「Administrator」チェックボックスをチェックしてもよいと思われます。)
「GENERATED URL」欄に表示されたURLをコピーして、コピーしたURLにアクセスします。
ボットを参加させたいサーバーを選択し、「Yes」をクリックします。
認証が正しいことを確認し、認証をクリックします。
hCaptchaの認証をクリアして、BOTをエンカレッジする。
これで、Discord BOTの事前設定は完了です。
このリポジトリをgithubからzipファイルでダウンロードするか、GithubCLIなどでcloneしてください。
https://github.com/tarou-software/GenshinArtifacter_Discrord-BOT
(ZIPファイルでダウンロードされた方は、解凍してください。)
ディレクトリ内の「.env」ファイルを開き、「Please Here Your Discord BOT TOKEN」を「Token Generation」でコピーしたBOTトークンに置き換えます。
BOTのソースコードが入っているディレクトリ内に、「config.json」というファイルが存在します。
このファイルはBOTの設定を変更するものです。
起動前に変更する必要がある箇所があるので、テキストエディタなどで開きます。
"Administrator_Name" : "Please Enter Your Name",
という行の「Please Enter Your Name」をあなたのニックネームに変更してください。
これは、EnkaNetworkのAPIを使用するために必要な設定ですので必ず行ってください。
また、
"BOT_Ver" : ~~~,
という項目は変更しないでください。
任意の設定
"uid_register" : true,
この項目を変更することで、UIDの登録を可能にするかしないかを設定できます。
- 有効にする場合は、「true」
- 無効にする場合は、「false」
に変更してください。
(初期設定は有効の「true」です。)
"image_uid_mode" : true
この項目を変更することで、タイミングによっては別の人の画像が送信されるという事態を回避することができます。
- 有効にする場合は、「true」
- 無効にする場合は、「false」
に変更してください。
(初期設定は有効の「true」です。)
クリックして開く
バージョンの確認コマンドを実行してpythonがインストールされているかを確認します。
python --version
バージョンが表示されたらOKです。
(インストールされていない場合、公式ページからインストーラーをダウンロードしてインストールしてください。)
pipを使用して、各ライブラリをインストールします。
コマンドは以下のとおりです。
各種ライブラリをインストールします。
pip install discord.py
pip install python-dotenv
pip install Pillow
pip install pyyaml
pip install requests
すべてが正しくインストールされたことを確認してください。
(Pillowのバージョンは必ず9.5.0以上にしてください。ArtifacterImageGenが動作しません。例:8.1.2では動きません。)
コマンドプロンプトなどを起動します。
カレントディレクトリをソースディレクトリに変更します。
次のコマンドを実行します。
python bot_start.py
(バッチスクリプトファイルを作成することをお勧めします。）
「Ready! Name:~~」と表示され、Discord上でBOTが正常に動作していることを確認してください。
クリックして開く
バージョンの確認コマンドを実行してpythonがインストールされているかを確認します。
python3 --version
バージョンが表示されたらOKです。
pipをインストールします。
sudo apt update
sudo apt install python3-pip
pipを使用して、各ライブラリをインストールします。
コマンドは以下のとおりです。
各種ライブラリをインストールします。
pip3 install discord.py
pip3 install python-dotenv
pip3 install Pillow
pip3 install pyyaml
pip3 install requests
すべてが正しくインストールされたことを確認してください。
(Pillowのバージョンは必ず9.5.0以上にしてください。ArtifacterImageGenが動作しません。例:8.1.2では動きません。)
コマンドプロンプトなどを起動します。
カレントディレクトリをソースディレクトリに変更します。
次のコマンドを実行します。
python3 bot_start.py
(シェルスクリプトファイルを作成することをお勧めします。）
「Ready! Name:~~」と表示され、Discord上でBOTが正常に動作していることを確認してください。
ArtifacterImageGenの仕様上、原神のバージョンアップが行われた際に追加される新要素に対応するためにはアセットの更新が必要になります。
クリックして開く
以下のコマンドでLTS版のNode.jsをインストールします。
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt install nodejs -y
カレントディレクトリをソースディレクトリに変更します。
次のコマンドを実行します。
npm install enka-network-api
クリックして開く
重要 更新するときは、EnkaNetworkがメンテナンスをしていないことを確認してください。
更新をするには、カレントディレクトリをソースディレクトリに変更し以下のコマンドを実行します。
node asset_update.js
(シェルスクリプトファイルを作成することをお勧めします。）
実行すると、自動でキャラクター・武器・聖遺物のアセットを更新します。
更新時にBOTの再起動は不要です。
「原神」は、上海米哈游綱絡科技股分有限公司(miHoYo)またCOGNOSPHEREの登録商標または商標です。
© COGNOSPHERE. All Rights Reserved.
ArtifacterImageGen Copyright (c) Hyugo(FuroBath) (artifacterbot - Twitter)
GenshinArtifacter_Discrord-BOT Copyright (c) mendoitarou_
EnkaNetworkAPI(ライブラリ) Copyright (c) yuko1101
このREADME-ja.mdは「DeepL翻訳ツール」を使用して、一部の文章が日本語から英語に翻訳した後、英語から日本語に翻訳されています。
https://www.deepl.com/ja/translator
返信に時間がかかる場合がありますので、ご了承ください。
開発終了につき、当BOTについてお問い合わせいただいても返信できかねます。ご了承ください。
Twitter: @mendoitarou_
E-Mail: contact@mendoitarou.com
クリックして開く
- 例外処理を追加
- 一部内部コードの最適化
クリックして開く
- メンテナンス時にエラーが発生して例外処理が動いていない問題を修正しました。メンテナンス時にはメッセージが送信されます。
クリックして開く
- 新しいプレイヤーアイコン形式への対応
- APIの返答をキャッシュするように仕様変更(APIの推奨される動作)
クリックして開く
- UIDを手動で入力して画像を生成するコマンドを追加
クリックして開く
- キャラクターの凸数が表示されない問題を修正
クリックして開く
- 聖遺物をつけていないキャラの画像を生成しようとしたときに、エラーが発生して画像が生成されない問題を修正。
クリックして開く
- BOTに関する情報を確認するコマンド名を変更
- コマンドの説明を見れるコマンドを追加
クリックして開く
- 生成画像キャラの元素に応じて埋め込みの色を変化
- アセット更新プログラムを追加
クリックして開く
- APIのルールに従えていない箇所があったので修正。
- UIDを登録しなかった場合の動作を変更
- 動作変更に伴い、/build_noコマンドの削除
- 画像生成の際、タイミングによっては別ユーザーの画像が生成される可能性がある問題を修正(コンフィグでON/OFF可能)
- 動作変更に伴い、READMEに説明を追記
クリックして開く
- 初期リリース