This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
denvodiscord [2022/12/04 07:11] – created denvo | denvodiscord [2022/12/04 12:38] (current) – denvo | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | == DenvoDiscord == | + | ===== DenvoDiscord ===== |
+ | |||
+ | ====Overview==== | ||
+ | |||
+ | DenvoDiscord is an add-on that allows Minion and Discord to communicate with each other.\ | ||
+ | By using this add-on, you can send chats received from FFXIV to Discord and control Minion from Discord.\\ | ||
+ | |||
+ | This add-on requires an application called DenvoCore. DenvoCore is a platform for integrating Minion and Discord, and by combining multiple add-ons, a variety of functions can be realized.\\ | ||
+ | |||
+ | ====Functions==== | ||
+ | |||
+ | Minion to Discord - Send chats received in FFXIV to Discord.\\ | ||
+ | Send from Discord to Minion - Minion can be controlled from Discord by using commands set in DenvoDiscord. You can also send standard FFXIV text commands by using Prefix+FFXIV text command.\\ | ||
+ | Provide API - DenvoDiscord provides API. By using this API, you can easily send any text you like to Discord.\\ | ||
+ | ====How to install==== | ||
+ | |||
+ | Install DenvoCore and DenvoDiscord.\\ | ||
+ | Create a Bot from https:// | ||
+ | Get the Bot's token and add it to DenvoDiscord' | ||
+ | Invite the Bot to the Discord server and give it the necessary permissions.\\ | ||
+ | Start DenvoDiscord and make sure it is connected properly.\\ | ||
+ | ====UI Description==== | ||
+ | |||
+ | Status - Running when it is working properly. If some error occurs, it stops automatically.\\ | ||
+ | Select the page you want to set.\\ | ||
+ | Select the type of chat you want to send to Discord.\\ | ||
+ | You can choose whether or not to send the chat selected in 3.\\ | ||
+ | If you want to send to a channel other than the main setting, you can make special settings here.\\ | ||
+ | If that type of chat is sent, a mention will be sent with @everyone.\\ | ||
+ | Write the command to be used after the prefix.\\ | ||
+ | If you are writing a multi-line command, it is convenient to check each one individually.\\ | ||
+ | Write the command. Basically, use Minion' | ||
+ | If you write more than 10 commands, a line will be automatically added. Don't worry about it!\\ | ||
+ | Enter your Discord bot token here.\\ | ||
+ | Enter the ServerID; you don't have to enter the ChannelID if you want to enter it directly.\\ | ||
+ | Get ChannelID from ServerID. From then on, the ChannelID input field will be a pull-down menu.\\ | ||
+ | Enter the ChannelID.\\ | ||
+ | Enter the desired Prefix. We recommend a single symbol. If it is complicated, | ||
+ | Retainer Sales system chat will be converted to CSV and output.\\ | ||
+ | Output by character.\\ | ||
+ | Set the date.\\ | ||
+ | Output the log of DenvoDiscord. It would be very helpful if you could send it to us when you report a bug.\\ | ||
+ | ====Description of API==== | ||
+ | |||
+ | DenvoAPI.DenvoDiscord: | ||
+ | |||
+ | At first, send text to the main channel which is set by DenvoDiscord.\\ | ||
+ | |||
+ | DenvoAPI.DenvoDiscord: | ||
+ | |||
+ | For now, you can send text to any bot and channel you like.\\ | ||
+ | |||
+ | The API is tentative. We will fix it soon.\\ | ||
+ | |||
+ | I haven' | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
=== 概要 === | === 概要 === | ||
Line 22: | Line 84: | ||
=== インストール方法 === | === インストール方法 === | ||
- | 1. DenvoCoreとDenvoDiscordをインストールします。 | + | 1. DenvoCoreとDenvoDiscordをインストールします。\\ |
- | 2. https:// | + | 2. https:// |
- | 3. Botのトークンを取得し、DenvoDiscordの設定に追加します。 | + | 3. Botのトークンを取得し、DenvoDiscordの設定に追加します。\\ |
- | 4. DiscordサーバーにBotを招待し、必要な権限を与えます。 | + | 4. DiscordサーバーにBotを招待し、必要な権限を与えます。\\ |
5. DenvoDiscordを起動し、正常に接続されていることを確認します。 | 5. DenvoDiscordを起動し、正常に接続されていることを確認します。 | ||
=== UIの説明 === | === UIの説明 === | ||
- | 1. ステータスです。正常に作動しているときはRunningになります。何らかのエラーが発生した場合は自動で停止します。 | + | 1. ステータスです。正常に作動しているときはRunningになります。何らかのエラーが発生した場合は自動で停止します。\\ |
- | 2. 設定したいページを選択します。 | + | 2. 設定したいページを選択します。\\ |
- | 3. Discordへ送信するFFXIVのチャットの種類を選択します。 | + | 3. Discordへ送信するFFXIVのチャットの種類を選択します。\\ |
- | 4. 3で選択したチャットを送るかどうかを選択することができます。 | + | 4. 3で選択したチャットを送るかどうかを選択することができます。\\ |
- | 5. メインの設定以外のチャンネルに送信する場合は、ここで特別に設定することができます。 | + | 5. メインの設定以外のチャンネルに送信する場合は、ここで特別に設定することができます。\\ |
- | 6. その種類のチャットが送信される場合、@everyoneでメンションが送信されます。 | + | 6. その種類のチャットが送信される場合、@everyoneでメンションが送信されます。\\ |
+ | |||
+ | 1. Prefix以降に使用されるコマンドを書きます。\\ | ||
+ | 2. 複数行に渡るコマンドを書く場合は、個々にチェックを入れると便利です。\\ | ||
+ | 3. コマンドを書きます。基本的にはMinionのloadstringを使用します。他のアドオンのAPIが動作しない可能性もあります。\\ | ||
+ | 4. 10以上のコマンドを書いた場合、自動的に行が追加されます。気にしないで大丈夫です!\\ | ||
+ | |||
+ | 1. ここにDiscordのBotのトークンを入力します。\\ | ||
+ | 2. ServerIDを入力します。ChannelIDを直接入力する場合は入力しなくても大丈夫です。\\ | ||
+ | 3.ServerIDからChannelIDを取得します。以降、ChannelIDの入力欄がプルダウンメニューになります。\\ | ||
+ | 4.ChannelIDを入力してください。\\ | ||
+ | 5.希望のPrefixを入力してください。おすすめは記号1文字です。複雑な場合は検証してません。\\ | ||
+ | 6.Retainer SalesのシステムチャットをCSVに変換し出力します。\\ | ||
+ | 7.キャラクターごとに出力します。\\ | ||
+ | 8.日付の設定をします。\\ | ||
+ | 9.DenvoDiscordのログを出力します。バグ報告をするときに送ってくれると非常に助かります。 | ||
+ | |||
+ | APIの説明 | ||
+ | |||
+ | DenvoAPI.DenvoDiscord: | ||
+ | return bool | ||
+ | |||
+ | とりあえずDenvoDiscordで設定してあるメインチャンネルへテキストを送信します。 | ||
+ | |||
+ | DenvoAPI.DenvoDiscord: | ||
+ | return nil | ||
+ | とりあえず好きなBot、チャンネルにテキストを送信することができます。 | ||
+ | |||
+ | APIは仮のものです。 | ||
+ | そのうち直します。 | ||
- | 1. Prefix以降に使用されるコマンドを書きます。 | ||
- | 2. 複数行に渡るコマンドを書く場合は、個々にチェックを入れると便利です。 | ||
- | 3. コマンドを書きます。基本的にはMinionのloadstringを使用します。他のアドオンのAPIが動作しない可能性もあります。 | ||
- | 4. 10以上のコマンドを書いた場合、自動的に行が追加されます。気にしないで大丈夫です! | ||
- | 1. ここにDiscordのBotのトークンを入力します。 | + | 日本語、英語以外の言語は検証してません。 |
- | 2. ServerIDを入力します。ChannelIDを直接入力する場合は入力しなくても大丈夫です。 | + | もし不具合、誤訳がありましたら気軽に連絡してください。 |
- | 3. ServerIDからChannelIDを取得する場合、ここにChannelIDを入力します。 | + | |
- | 以上が、DenvoDiscordの使い方と設定方法です。 | ||
- | FFXIVとDiscordをより便利に使えるようになります。 | ||
- | ぜひお試しください。 |