# NekoGakuen_DiscordFeedback.js - User Manual
:::danger

:::
:::warning
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> This article was translated using "[ChatGPT](https://chatgpt.com/g/g-BBGmFnGT4-ji-qi-lang)".
:::
> ## ◆ Directory
> * [How to install this plugin in RPG Maker MV/MZ software](#%E2%97%86-How-to-install-this-plugin-in-RPG-Maker-MVMZ-software)
> * [How to Connect This Plugin to a Discord Server](#%E2%97%86-How-to-Connect-This-Plugin-to-a-Discord-Server)
> * [About the Plugin Parameter Setting Features](#%E2%97%86-About-the-Plugin-Parameter-Setting-Features)
> * [How to use the features of this plugin in RPG Maker MV/MZ games](#%E2%97%86-How-to-use-the-features-of-this-plugin-in-RPG-Maker-MVMZ-games)
> * [How to install a third-party translation module in RPG Maker MV/MZ software](#%E2%97%86-How-to-install-a-third-party-translation-module-in-RPG-Maker-MVMZ-software)
> * [Terms of Use](#%E2%97%86-Terms-of-Use)
> * [Extra: Reference Resources](#%E2%97%86-Extra-Reference-Resources)
## ◆ How to install this plugin in RPG Maker MV/MZ software
#### **1.** After downloading and extracting the files, place the plugin (`NekoGakuen_DiscordFeedback.js`) and the corresponding language translation module (`NekoGakuen_DiscordFeedback_en_US.js`) into the `js/plugins/` folder of your game project.

#### **2.** After opening your game project open the Plugin Manager (keyboard shortcut is <kbd>F10</kbd>) and install the plugin by mouse left-clicking twice.
:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> The core version of RPG Maker MV software and project is recommended to be 1.6.2 or above.
:::
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span>


:::
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span>


:::
#### **3.** Select the translation module in the top-left corner, then configure its parameters in the right-side area. For detailed explanations of the plugin parameters, refer to the section "[About the Plugin Parameter Setting Features](#%E2%97%86-About-the-Plugin-Parameter-Setting-Features)".
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span>

:::
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span>

:::
#### **4.** Return to the Plugin Manager and install the main plugin below the translation module.
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span>

:::
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span>

:::
#### **5.** In the parameter "<span style="color:DimGray;">#→Translation Plugin Patch</span>" Plugin Patch of the main plugin, input the file name of the translation module. Any subsequent plugin parameter settings can be configured directly within the translation module you are currently using.
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span>

:::
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span>

:::
## ◆ How to Connect This Plugin to a Discord Server
#### **1.** Open a browser and visit the following URL to register or login to your Discord account, then download and install the Discord desktop client.
:::info
**<i class="fa fa-link" aria-hidden="true"></i>** https://discord.com
:::

#### **2.** In any "Text Channel" of your "Discord Server", click the "+" button to "Create Thread".

#### **3.** Set a "Thread Name" and enter any text to create the thread.

:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> To create a feedback thread visible only to "game developers", check "Private Thread".
:::
#### **4.** In your "Discord Server", click the server name in the upper left to open the menu, and select "Server Settings".

:::warning
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> The "Server Settings" function is only available to accounts with "Admin Permissions".
:::
#### **5.** Under the "Integrations" tab, select "Webhooks" and click "New Webhook" to create a new one.


#### **6.** Configure the icon, name, and the "Text Channel" for the thread created earlier, then click "Save Changes". "Copy Webhook URL" and paste it into the "[Discord Webhook URL](#%E2%94%80-Discord-Webhook-URL)".

#### **7.** Open a browser and visit the following URL to register or login to your Imgur account.
:::info
**<i class="fa fa-link" aria-hidden="true"></i>** https://imgur.com
:::

#### **8.** Go to the following URL, enter "Application Name", "Authorization Callback URL," and "Email". For "Authorization Callback URL", simply enter "https://imgur.com". Then click "Submit".
:::info
**<i class="fa fa-link" aria-hidden="true"></i>** https://api.imgur.com/oauth2/addclient
:::

:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> To view or edit existing apps and Client ID, visit:
https://imgur.com/account/settings/apps

:::
#### **9.** Copy the "Client ID" and paste it into the "[Imgur Client ID](#%E2%94%80-Imgur-Client-ID)".

#### **10.** Open the Discord client. In the bottom-left corner, click the gear icon next to your username to open "User Settings".

#### **11.** Under the "Advanced" tab, enable "Developer Mode".

#### **12.** Return to the previously created "Thread", right-click to select "Copy Thread ID", and paste it into the "[Discord Thread ID](#%E2%94%80-Discord-Thread-ID)".

## ◆ About the Plugin Parameter Setting Features
### ─ Discord Webhook URL
---
Set the Webhook URL of the Discord text channel.

### ─ Imgur Client ID
---
Set the Client ID of the Imgur API for uploading screenshots.

### ─ Discord Thread ID
---
Set the Thread ID of the Discord text channel.

## ◆ How to use the features of this plugin in RPG Maker MV/MZ games
### ■ Call Feedback Form
---
Call the feedback form window in the game.
**● Plugin Command:**
`NekoCommands DiscordFeedback_CallFeedback`
**● Script:**
`DiscordFeedbackManager.openBugReportWindow();`
## ◆ How to install a third-party translation module in RPG Maker MV/MZ software
#### **1.** Open the "Plugin Manager" (keyboard shortcut <kbd>F10</kbd>) in your game project and install the third-party translation module by mouse left-clicking twice on the top of this plugin.
#### **2.** Then enter the plugin file name of the translation module in the "<span style="color:DimGray;">#→Translation Plugin Patch</span>" parameter of the plugin, and then set the plugin parameters in the third-party translation module you are currently using.
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span>


:::
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span>


:::
:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> **About the Translation Module**
Because the author himself does not have a lot of time to do plugin translation, so the author open **Translation plugin template (NekoGakuen_MulitLanguage_TransMod.js)** for other people who want to translate the translation of the convenience of translation directly to use, without having to modify the plugin, see the plugin to understand the details of the plugin, and then use the plugin provided by the author of the template for translation.
:::
## ◆ Terms of Use
No prior notice is required to modify or translate this plugin, and if the plugin has bugs you can report them.
The copyright of this plugin is owned by [NekoGakuen](https://twitter.com/NekoGakuen).
We also reserve the right to modify and change the rules of use of the plugin.
**- Credit:**<span style="color:green;"> [△ Not required, but appreciated if you have one. (#1)]</span>
**- Commercial:**<span style="color:green;"> [√ OK]</span>
**- Adults:**<span style="color:green;"> [√ OK]</span>
:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> **#1:**
If you want to attach it, you can mark it with "NekoGakuen".
:::
## ◆ Extra: Reference Resources
Some of the screenshots in this manual are based on the free icon material "[FREE Keyboard and controllers prompts pack](https://opengameart.org/content/free-keyboard-and-controllers-prompts-pack)" designed by "[Nicolae (Xelu) Berbece](https://twitter.com/xelubest)".
**NekoGakuen - Official Twitter(X)**
https://x.com/NekoGakuen
**NekoGakuen - Official Blogger**
https://nekogakuen.blogspot.com
###### tags: `插件使用手冊` `貓咪學園` `NekoGakuen` `RPG Maker MV` `RPG Maker MZ`