# NekoGakuen_MulitLanguage.js - User Manual :::danger ![](https://i.imgur.com/XKmDnbq.png) ::: :::warning <i class="fa fa-exclamation-triangle" aria-hidden="true"></i> This article was translated using "[DeepL Translator](https://www.deepl.com/translator)". ::: > ## ◆ 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 create multi-language text files using Gooole spreadsheets](#%E2%97%86-How-to-create-multi-language-text-files-using-Gooole-spreadsheets) > * [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 unzipping the file, place the plugin in the `js/plugins/` folder of your game project. ![](https://i.imgur.com/BZQhd57.png) #### **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> ![](https://i.imgur.com/dm3wbP0.png) ![](https://i.imgur.com/htmcFye.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/qkes6vF.png) ![](https://i.imgur.com/OHIskqp.png) ::: #### **3.** After selecting this plugin on the top left, set some functions in the "Parameters" in the right area, and the detailed functions of this plugin's "Parameters" can be found in "[About the Plugin Parameter Setting Features](#%E2%97%86-About-the-Plugin-Parameter-Setting-Features)". :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/f4pZvWV.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/WBlVY1G.png) ::: ## ◆ How to create multi-language text files using Gooole spreadsheets #### **1.** Open your browser software and go to the following website to register or sign in to your Google account. :::info **<i class="fa fa-link" aria-hidden="true"></i>** https://www.google.com.tw/intl/en/sheets/about/ ::: ![](https://i.imgur.com/g1C3o2J.png) #### **2.** Then click the "+" button in the lower right corner of the screen to add a Google spreadsheet. ![](https://i.imgur.com/k0jPnAe.png) #### **3.** Enter some text into the Google spreadsheet and format it as shown below. ![](https://i.imgur.com/YuPZ5KO.png) > **Green Area:** > Enter the language parameters that your game project can support, for checking the language, the language name can be named freely. > [color=greenyellow] > **Yellow Area:** > Enter the parameters of your game project that need to be called content, the name of the call parameter can be named freely. > [color=gold] > **Blue Area:** > Enter text in various languages according to the corresponding fields. > [color=skyblue] > :::warning <i class="fa fa-exclamation-triangle" aria-hidden="true"></i> However, it should be noted that there should not be any space, if you really need a space you can use "_" instead of space. ::: ![](https://i.imgur.com/fpSI4MI.png) :::info <i class="fa fa-info-circle" aria-hidden="true"></i> To use the "[NekoGakuen_SteamworksAPI.js](https://rabbitteaparty.itch.io/nekogakuen-steamworksapi)" plugin, the name of the **language parameter<span style="color:green;">(Green Area)</span>** must match the name of the official Steam supported "API language code" field. **<i class="fa fa-link" aria-hidden="true"></i>** https://partner.steamgames.com/doc/store/localization/languages ![](https://i.imgur.com/nJgnxrD.png) ::: :::info <i class="fa fa-info-circle" aria-hidden="true"></i> In addition, this plugin supports line breaks in the text dialog of the game, just use "<kbd>Alt</kbd> + <kbd>Enter</kbd>" on your keyboard in the text field you want to change the line. ![](https://i.imgur.com/zQpLHDJ.png) ::: #### **4.** Click "File" → "Download" → "Comma Separated Values(.csv)" on top of the Google Spreadsheet to download the CSV file, rename the CSV file, and place it in the game project folder. ![](https://i.imgur.com/RdPfyeW.png) ![](https://i.imgur.com/H9HTAF9.png) ## ◆ About the Plugin Parameter Setting Features ### ─ Custom Fontlist... --- **● Fonts File Name:** Set the font name to be called. **● Fonts File Format:** Set the font file extension format. :::info <i class="fa fa-info-circle" aria-hidden="true"></i> This parameter does not need to be set if the "[NekoGakuen_FontManager.js](https://rabbitteaparty.itch.io/nekogakuen-fontmanager)" plugin is installed. ::: ![](https://i.imgur.com/Y7huzOm.png) ### ─ Text Language List... <span style="color:red;">(*Required)</span> --- **● CSV Name:** Specifies the parameter name of the external text CSV file. **● CSV File:** Specifies the CSV file path of the external text. :::warning <i class="fa fa-exclamation-triangle" aria-hidden="true"></i> However, it should be noted that there should not be any space, if you really need a space you can use "_" instead of space. ::: ![](https://i.imgur.com/Yd1ke9Z.png) ### ─ Custom Game Language... <span style="color:red;">(*Required)</span> --- **● Language Key:** Set your **Language parameter <span style="color:green;">(Green Area)</span>** name in the CSV file. **● Language Name:** Specify the display name of the game language. :::warning <i class="fa fa-exclamation-triangle" aria-hidden="true"></i> However, it should be noted that there should not be any space, if you really need a space you can use "_" instead of space. ::: **● Language FontName:** Specify the font name to be displayed in the game language. **● Language FontSize:** Specifies the font size to be displayed for that game language. **● Init Language Description:** Set the text description of the game language for the initial selection item, e.g. this parameter can be ignored when "[Init Language](#%E2%98%85-Init-Language)" is disabled. ![](https://i.imgur.com/jowekP8.png) ### ─ Language Command --- Specify the language commands to be used in the "Database" (keyboard shortcut is <kbd>F9</kbd>), and the language commands to be used for "Control Characters" in the **Event Commands** "Display Text..." command. commands, and the actual use of the features of this plugin in RPG Maker MV/MZ software can be found in "[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)". ![](https://i.imgur.com/T1qGBdf.png) ### ─ Language Select Type --- Set the type of language selection. * Player's choice * From the Steam client **(#1)** * From the Steam Game **(#1)** :::info <i class="fa fa-info-circle" aria-hidden="true"></i> **#1:** If you choose Steam language, you need to install "[NekoGakuen_SteamworksAPI.js](https://rabbitteaparty.itch.io/nekogakuen-steamworksapi)" plugin. ::: ![](https://i.imgur.com/PdrfROr.png) ### ─ Show Option Language --- Whether to enable the language setting in the game settings "Option". ![](https://i.imgur.com/naFO3hu.png) ### ─ Option Name --- Set the name of the "Options" setting on the title screen. ![](https://i.imgur.com/0VcBKcH.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/LWwmSmQ.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/iDt1WlT.png) ::: ### ─ Game Title --- Set the title of the game. :::info <i class="fa fa-info-circle" aria-hidden="true"></i> The parameters of this plugin are new since version 2.0.4. ::: ### ─ Init language select... --- Each of the following parameters is described in detail. ![](https://i.imgur.com/E6xM6Na.png) ### ★ Init Language --- Whether you need to open the language select at the beginning of the game. ![](https://i.imgur.com/Kz3RzTi.png) ### ★ Picture Background --- Specify the background image for the initial language selection screen. The picture file is placed in the `img/pictures` folder. ![](https://i.imgur.com/7IoP3Cz.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/So4YlN2.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/G4vfX5e.png) ::: ### ★ Select window X Align --- Specifies the X-axis alignment type of the language selection window. ![](https://i.imgur.com/V5mQJt9.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/D9ozjrs.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/aWtsZUs.png) ::: ### ★ Select window Y Align --- Specifies the Y-axis alignment type of the language selection window. ![](https://i.imgur.com/yzlnqep.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/aXaWla6.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/FeqcBTl.png) ::: ### ★ Select Window Width --- Specifies the display width of the language selection window. ![](https://i.imgur.com/SHis3Xa.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/UVBYsJs.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/bocxfoH.png) ::: ### ★ Select Window Opacity --- Specifies the opacity of the language selection window. ![](https://i.imgur.com/xZwQ9Ct.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/ScD09YH.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/cByqPnr.png) ::: ### ★ Text Alignment --- Specifies the alignment of the text display in the language selection window. ![](https://i.imgur.com/SbAjAra.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/9YrQOUX.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/7HpGobZ.png) ::: ### ★ Show Language Help --- Whether to show the language help at the beginning of the game. ![](https://i.imgur.com/qTcqyQd.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/3cW7oWj.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/THLGknp.png) ::: ### ★ Help window Y Align --- Specifies the Y-axis alignment type of the language help window. ![](https://i.imgur.com/ziYpVJV.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/E2z5HoA.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/rVCTkrT.png) ::: ### ★ Description Opacity --- Specifies the opacity of the language description window. ![](https://i.imgur.com/I6BYYJu.png) :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV**</span> ![](https://i.imgur.com/JWf9ZpM.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/5JXH7Hp.png) ::: ## ◆ How to use the features of this plugin in RPG Maker MV/MZ games ### ■ Change Game Language --- Set the language you want to display in the game, which must match the **Language parameter<span style="color:green;">(Green Area)</span>** field of the CSV file. **● Plugin Command:** NekoCommands MulitLang_SET <span style="color:green;"><Parameters></span> **● Script:** $gameSystem.mulitLangSET("<span style="color:green;"><Parameters></span>"); **● <span style="color:green;">Parameters</span>:** You are in the **Language Parameters<span style="color:green;">(Green Area)</span>** field of the CSV file. ### ■ Get Game Language --- Get the language you are currently displaying in the game, which must match the **Language parameter<span style="color:green;">(Green Area)</span>** field of the CSV file. **● Plugin Command:** NekoCommands MulitLang_GET <span style="color:green;"><Parameters></span> **● Conditional Branch:** $gameSystem.mulitLangGET() == "<span style="color:DarkKhaki;"><Conditional Args></span>"; **● <span style="color:green;">Parameters</span>:** Variable ID. **● <span style="color:DarkKhaki;">Conditional Args</span>:** language Args. ### ■ Call Multilingual Messages --- Call the specified text item, "**\Say**" can be changed at **[Language Command](#%E2%94%80-Language-Command)**. **● Contol Characters:** \Say[<span style="color:green;"><parameter01></span>] \Say[<span style="color:green;"><parameter01></span>,<span style="color:green;"><parameter02></span>] **● <span style="color:green;">Parameter01</span>:** You are in the **Language Parameters<span style="color:green;">(Green Area)</span>** field of the CSV file. **● <span style="color:green;">Parameter02</span>:** The "**Text Parameters**" that you set in the Plugin Manager "**[Text Language List…](#%E2%94%80-Text-Language-List%E2%80%A6-%EF%BC%8ARequired)**". :::warning <i class="fa fa-exclamation-triangle" aria-hidden="true"></i> However, it should be noted that there should not be any space, if you really need a space you can use "_" instead of space. ::: ### ■ Call Multilingual Messages (*Retaining the original text for annotation) --- Add the text item specified by the call before or after the original text, "**\Say**" can be changed at **[Language Command](#%E2%94%80-Language-Command)**. **● Contol Characters:** \Say[<span style="color:green;"><Parameter01></span>,<span style="color:green;">true</span>] \Say[<span style="color:green;"><Parameter01></span>,<span style="color:green;"><Parameter02></span>,<span style="color:green;">true</span>] **● <span style="color:green;">Parameter01</span>:** You are in the **Language Parameters<span style="color:green;">(Green Area)</span>** field of the CSV file. **● <span style="color:green;">Parameter02</span>:** The "**Text Parameters**" that you set in the Plugin Manager "**[Text Language List…](#%E2%94%80-Text-Language-List%E2%80%A6-%EF%BC%8ARequired)**". :::warning <i class="fa fa-exclamation-triangle" aria-hidden="true"></i> However, it should be noted that there should not be any space, if you really need a space you can use "_" instead of space. ::: ## ◆ 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> ![](https://i.imgur.com/XoQDVLo.png) ![](https://i.imgur.com/eZKwnrs.png) ::: :::spoiler <span style="color:LightSlateGrey;">**RPG Maker MZ**</span> ![](https://i.imgur.com/4YlimkY.png) ![](https://i.imgur.com/GmFIVhK.png) ::: :::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)". Mirai - Patreon: https://www.patreon.com/MiraiDiary Mirai - Twitter(X): https://twitter.com/Mirai_so_Sad Mirai - itch.io: https://miraisosad.itch.io Mirai - Instagram https://www.instagram.com/miraisosad/ ###### tags: `插件使用手冊` `貓咪學園` `NekoGakuen` `RPG Maker MV` `RPG Maker MZ`