HackMDNekoGakuen_MulitLanguage.js - User Manual
This article was translated using "DeepL Translator".
◆ Directory
- How to install this plugin in RPG Maker MV/MZ software
- How to create multi-language text files using Gooole spreadsheets
- About the Plugin Parameter Setting Features
- How to use the features of this plugin in RPG Maker MV/MZ games
- How to install a third-party translation module in RPG Maker MV/MZ software
- Terms of Use
- 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.
2. After opening your game project open the Plugin Manager (keyboard shortcut is F10) and install the plugin by mouse left-clicking twice.
The core version of RPG Maker MV software and project is recommended to be 1.6.2 or above.
RPG Maker MV
RPG Maker MZ
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".
RPG Maker MV
RPG Maker MZ
◆ 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.
2. Then click the "+" button in the lower right corner of the screen to add a Google spreadsheet.
3. Enter some text into the Google spreadsheet and format it as shown below.
Green Area:
Enter the language parameters that your game project can support, for checking the language, the language name can be named freely.
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.
Blue Area:
Enter text in various languages according to the corresponding fields.
However, it should be noted that there should not be any space, if you really need a space you can use "_" instead of space.
To use the "NekoGakuen_SteamworksAPI.js" plugin, the name of the language parameter(Green Area) must match the name of the official Steam supported "API language code" field.
https://partner.steamgames.com/doc/store/localization/languages
In addition, this plugin supports line breaks in the text dialog of the game, just use "Alt + Enter" on your keyboard in the text field you want to change the line.
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.
◆ 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.
This parameter does not need to be set if the "NekoGakuen_FontManager.js" plugin is installed.
─ Text Language List… (＊Required)
● CSV Name:
Specifies the parameter name of the external text CSV file.
● CSV File:
Specifies the CSV file path of the external text.
However, it should be noted that there should not be any space, if you really need a space you can use "_" instead of space.
─ Custom Game Language… (＊Required)
● Language Key:
Set your Language parameter (Green Area) name in the CSV file.
● Language Name:
Specify the display name of the game language.
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" is disabled.
─ Language Command
Specify the language commands to be used in the "Database" (keyboard shortcut is F9), 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".
─ Language Select Type
Set the type of language selection.
- Player's choice
- From the Steam client (#1)
- From the Steam Game (#1)
#1:
If you choose Steam language, you need to install "NekoGakuen_SteamworksAPI.js" plugin.
─ Show Option Language
Whether to enable the language setting in the game settings "Option".
─ Option Name
Set the name of the "Options" setting on the title screen.
RPG Maker MV
RPG Maker MZ
─ Game Title
Set the title of the game.
The parameters of this plugin are new since version 2.0.4.
─ Init language select…
Each of the following parameters is described in detail.
★ Init Language
Whether you need to open the language select at the beginning of the game.
★ Picture Background
Specify the background image for the initial language selection screen.
The picture file is placed in the img/pictures folder.
RPG Maker MV
RPG Maker MZ
★ Select window X Align
Specifies the X-axis alignment type of the language selection window.
RPG Maker MV
RPG Maker MZ
★ Select window Y Align
Specifies the Y-axis alignment type of the language selection window.
RPG Maker MV
RPG Maker MZ
★ Select Window Width
Specifies the display width of the language selection window.
RPG Maker MV
RPG Maker MZ
★ Select Window Opacity
Specifies the opacity of the language selection window.
RPG Maker MV
RPG Maker MZ
★ Text Alignment
Specifies the alignment of the text display in the language selection window.
RPG Maker MV
RPG Maker MZ
★ Show Language Help
Whether to show the language help at the beginning of the game.
RPG Maker MV
RPG Maker MZ
★ Help window Y Align
Specifies the Y-axis alignment type of the language help window.
RPG Maker MV
RPG Maker MZ
★ Description Opacity
Specifies the opacity of the language description window.
RPG Maker MV
RPG Maker MZ
◆ 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(Green Area) field of the CSV file.
● Plugin Command:
NekoCommands MulitLang_SET <Parameters>
● Script:
$gameSystem.mulitLangSET("<Parameters>");
● Parameters:
You are in the Language Parameters(Green Area) field of the CSV file.
■ Get Game Language
Get the language you are currently displaying in the game, which must match the Language parameter(Green Area) field of the CSV file.
● Plugin Command:
NekoCommands MulitLang_GET <Parameters>
● Conditional Branch:
$gameSystem.mulitLangGET() == "<Conditional Args>";
● Parameters:
Variable ID.
● Conditional Args:
language Args.
■ Call Multilingual Messages
Call the specified text item, "\Say" can be changed at Language Command.
● Contol Characters:
\Say[<parameter01>]
\Say[<parameter01>,<parameter02>]
● Parameter01:
You are in the Language Parameters(Green Area) field of the CSV file.
● Parameter02:
The "Text Parameters" that you set in the Plugin Manager "Text Language List…".
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.
● Contol Characters:
\Say[<Parameter01>,true]
\Say[<Parameter01>,<Parameter02>,true]
● Parameter01:
You are in the Language Parameters(Green Area) field of the CSV file.
● Parameter02:
The "Text Parameters" that you set in the Plugin Manager "Text Language List…".
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 F10) 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 "＃→Translation Plugin Patch" parameter of the plugin, and then set the plugin parameters in the third-party translation module you are currently using.
RPG Maker MV
RPG Maker MZ
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.
We also reserve the right to modify and change the rules of use of the plugin.
- Credit: [△ Not required, but appreciated if you have one. (#1)]
- Commercial: [√ OK]
- Adults: [√ OK]
#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" designed by "Nicolae (Xelu) Berbece".
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/
