# NekoGakuen_MulitLanguage.js - 使用手冊

:::danger
:::

> ## ◆ 目錄
> * [如何在 RPG Maker MV/MZ 軟體安裝本插件](#%E2%97%86-%E5%A6%82%E4%BD%95%E5%9C%A8-RPG-Maker-MVMZ-%E8%BB%9F%E9%AB%94%E5%AE%89%E8%A3%9D%E6%9C%AC%E6%8F%92%E4%BB%B6)
> * [如何使用 Gooole 試算表建立多語言文字檔案](#%E2%97%86-%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8-Gooole-%E8%A9%A6%E7%AE%97%E8%A1%A8%E5%BB%BA%E7%AB%8B%E5%A4%9A%E8%AA%9E%E8%A8%80%E6%96%87%E5%AD%97%E6%AA%94%E6%A1%88)
> * [關於本插件參數設定的功能介紹](#%E2%97%86-%E9%97%9C%E6%96%BC%E6%9C%AC%E6%8F%92%E4%BB%B6%E5%8F%83%E6%95%B8%E8%A8%AD%E5%AE%9A%E7%9A%84%E5%8A%9F%E8%83%BD%E4%BB%8B%E7%B4%B9)
> * [如何在 RPG Maker MV/MZ 遊戲使用本插件的功能](#%E2%97%86-%E5%A6%82%E4%BD%95%E5%9C%A8-RPG-Maker-MVMZ-%E9%81%8A%E6%88%B2%E4%BD%BF%E7%94%A8%E6%9C%AC%E6%8F%92%E4%BB%B6%E7%9A%84%E5%8A%9F%E8%83%BD)
> * [如何在 RPG Maker MV/MZ 軟體安裝來自第三方的翻譯模組](#%E2%97%86-%E5%A6%82%E4%BD%95%E5%9C%A8-RPG-Maker-MVMZ-%E8%BB%9F%E9%AB%94%E5%AE%89%E8%A3%9D%E4%BE%86%E8%87%AA%E7%AC%AC%E4%B8%89%E6%96%B9%E7%9A%84%E7%BF%BB%E8%AD%AF%E6%A8%A1%E7%B5%84)
> * [著作聲明](#%E2%97%86-%E8%91%97%E4%BD%9C%E8%81%B2%E6%98%8E)
> * [附註：參考資源](#%E2%97%86-%E9%99%84%E8%A8%BB%EF%BC%9A%E5%8F%83%E8%80%83%E8%B3%87%E6%BA%90)

## ◆ 如何在 RPG Maker MV/MZ 軟體安裝本插件

#### **1.** 下載並解壓縮檔案之後，將本插件放在您的遊戲專案的`js/plugins/`資料夾。


#### **2.** 開啟您的遊戲專案後打開「插件管理器」(鍵盤快捷鍵為 <kbd>F10</kbd> )，並使用滑鼠左鍵兩下安裝插件。
:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> RPG Maker MV 軟體及專案的核心版本建議為 1.6.2 以上版本為佳。
:::
:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>


:::

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

:::

#### **3.** 在左上方選擇本插件後，在右邊區域的「參數」設定一些功能，而本插件「參數」的詳細功能，可參閱在「[關於本插件參數設定的功能介紹](#%E2%97%86-%E9%97%9C%E6%96%BC%E6%9C%AC%E6%8F%92%E4%BB%B6%E5%8F%83%E6%95%B8%E8%A8%AD%E5%AE%9A%E7%9A%84%E5%8A%9F%E8%83%BD%E4%BB%8B%E7%B4%B9)」。

:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

## ◆ 如何使用 Gooole 試算表建立多語言文字檔案

#### **1.** 開啟瀏覽器軟體並前往以下網址，進行註冊或登入 Google 帳號。

:::info
**<i class="fa fa-link" aria-hidden="true"></i>** https://www.google.com.tw/intl/zh-TW/sheets/about/
:::


#### **2.** 接著畫面右下角按下「+」按鈕來新增 Google 試算表。


#### **3.** 在 Google 試算表內輸入一些文字內容，並且按照如下圖的格式。


> **綠色區域：**
> 輸入您的遊戲專案能支援的語系參數，用於判斷語言，語系名稱可自由命名。
> [color=greenyellow]

> **黃色區域：**
> 輸入您的遊戲專案中需要呼叫內容的參數，呼叫參數的名稱可自由命名。
> [color=gold]

> **藍色區域：**
> 依照對應欄位輸入各種語言的文本內容。
> [color=skyblue]
>

:::warning
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> 但需要注意的是不能有任何的空格，如真的需要有空格可以改用「_」替代空格。
:::


:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> 如需使用「[NekoGakuen_SteamworksAPI.js](https://rabbitteaparty.itch.io/nekogakuen-steamworksapi)」插件時，在 **語系參數<span style="color:green;">(綠色區域)</span>** 的名稱必須與Steam官方支援的「API 語言碼」的欄位一致。

**<i class="fa fa-link" aria-hidden="true"></i>** https://partner.steamgames.com/doc/store/localization/languages

:::

:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> 此外，本插件在遊戲的文字對話上支援換行內容，只要在想要換行的文字欄位使用鍵盤上的「<kbd>Alt</kbd> + <kbd>Enter</kbd>」。

:::

#### **4.** 在 Google 試算表上方按「檔案」→「下載」→「逗號分隔值檔案 (.csv)」下載 CSV 檔案，並重新命名 CSV 檔案名稱後，放在遊戲專案資料夾內即可。



## ◆ 關於本插件參數設定的功能介紹

### ─ 自訂字型清單...
---

**● 字型名稱：**
設定要指定呼叫字型名稱。

**● 指定字型格式：**
指定字型名稱的檔案讀取格式。

:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> 如有安裝「[NekoGakuen_FontManager.js](https://rabbitteaparty.itch.io/nekogakuen-fontmanager)」插件時，該項參數則不必設置。
:::


### ─ 外部文本語言... <span style="color:red;">(※必要)</span>
---
**● 文本參數：**
設定要指定呼叫讀取 CSV 檔案的參數名稱，呼叫參數的名稱可自由命名。

**● 文本路徑：**
設定要指定呼叫讀取 CSV 檔案的所在路徑。

:::warning
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> 但需要注意的是不能有任何的空格，如真的需要有空格可以改用「_」替代空格。
:::


### ─ 自訂遊戲語言... <span style="color:red;">(※必要)</span>
---

**● 語言參數：**
設定您在 CSV 檔案的 **語系參數<span style="color:green;">(綠色區域)</span>** 名稱。

**● 語言名稱：**
設定該語言在遊戲中的設定選項所顯示的語言名稱。

:::warning
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> 但需要注意的是不能有任何的空格，如真的需要有空格可以改用「_」替代空格。
:::

**● 字型名稱：**
設定該語言在遊戲中所顯示的文字字型。

**● 字型大小：**
設定該語言在遊戲中所顯示的文字大小。

**● 初期語言說明：**
設定初期選擇項遊戲語言的文字說明，如「[初期語言功能](#%E2%94%80-%E5%88%9D%E6%9C%9F%E8%AA%9E%E8%A8%80%E9%81%B8%E6%93%87)」為關閉時則可以忽略此參數。


### ─ 語言命令
---

指定在「資料庫」(鍵盤快捷鍵為 <kbd>F9</kbd> )中使用的語言命令，以及在 **劇情命令(事件命令)** 「顯示文字...」命令之中，用於「控制字元」的語言命令，而實際在 RPG Maker MV/MZ 軟體的使用方式，可參閱在「[如何在 RPG Maker MV/MZ 遊戲使用本插件的功能](#%E2%97%86-%E5%A6%82%E4%BD%95%E5%9C%A8-RPG-Maker-MVMZ-%E9%81%8A%E6%88%B2%E4%BD%BF%E7%94%A8%E6%9C%AC%E6%8F%92%E4%BB%B6%E7%9A%84%E5%8A%9F%E8%83%BD)」。


### ─ 語言選擇類型
---

指定語言選擇的類型。
* 由玩家自行選擇
* 從 Steam 客戶端指定 **(註1)**
* 從 Steam 遊戲指定 **(註1)**

:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> **註1：**
如選擇來自 Steam 語言時，需安裝「[NekoGakuen_SteamworksAPI.js](https://rabbitteaparty.itch.io/nekogakuen-steamworksapi)」插件。
:::


### ─ 顯示選項語言
---

指定在遊戲設定「選項」的是否顯示「語言設定」。


### ─ 選項名稱
---

指定遊戲設定「選項」的語言設定。


:::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> 此插件參數為2.0.4版本以後所新增的參數。
:::

### ─ 初期語言選擇...
---

這裡會逐一介紹以下的每個參數細節。


### ★ 初期語言功能
---

是否在遊戲初始化時，開啟語言選擇的詢問功能。


### ★ 初期語言背景
---

指定在遊戲初始化時，顯示語言選擇畫面的背景圖片，圖片檔案請放在您的遊戲專案的`img/pictures/`資料夾。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 選擇項 X 軸對齊
---

指定在遊戲初始化時，指定語言選擇視窗的水平對齊位置。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 選擇項 Y 軸對齊
---

指定在遊戲初始化時，指定語言選擇視窗的垂直對齊位置。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 選擇項寬度
---

指定在遊戲初始化時，指定語言選擇視窗的寬度。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 選擇項不透明度
---

指定在遊戲初始化時，指定語言選擇視窗的不透明度。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 選擇項文字對齊
---

指定在遊戲初始化時，指定語言選擇視窗的文字對齊位置。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 顯示語言說明
---

指定在遊戲初始化時，是否顯示語言選擇畫面的說明視窗。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 說明 Y 軸對齊
---

指定在遊戲初始化時，指定語言說明視窗的垂直對齊位置。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

### ★ 語言說明不透明度
---

指定在遊戲初始化時，指定語言說明視窗的不透明度。


:::spoiler <span style="color:LightSlateGrey;">**RPG Maker MV 場合**</span>
:::

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

## ◆ 如何在 RPG Maker MV/MZ 遊戲使用本插件的功能

### ■ 變更遊戲語言
---

指定您在遊戲中所顯示的語言，而顯示的語言必須跟 CSV 檔案的 **語系參數<span style="color:green;">(綠色區域)</span>** 欄位一致。

**● 插件命令：**
NekoCommands MulitLang_SET <span style="color:green;"><參數></span>

**● 腳本：**
$gameSystem.mulitLangSET("<span style="color:green;"><參數></span>");

**● <span style="color:green;">參數</span>：**
您在 CSV 檔案的 **語系參數<span style="color:green;">(綠色區域)</span>** 欄位。

### ■ 取得目前語言
---

取得目前您在遊戲中所顯示的語言，而顯示的語言必須跟 CSV 檔案的 **語系參數<span style="color:green;">(綠色區域)</span>** 欄位一致。

**● 插件命令：**
NekoCommands MulitLang_GET <span style="color:green;"><參數></span>

**● 條件分歧：**
$gameSystem.mulitLangGET() == "<span style="color:DarkKhaki;"><條件參數></span>";

**● <span style="color:green;">參數</span>：**
您的「變數 ID」。

**● <span style="color:DarkKhaki;">條件參數</span>：**
您的語言參數。

### ■ 呼叫多國語言文本
---
呼叫指定的文本項目，「**\Say**」可在 **[語言命令](#%E2%94%80-%E8%AA%9E%E8%A8%80%E5%91%BD%E4%BB%A4)** 變更。

**● 文字指令：**

\Say[<span style="color:green;"><參數01></span>]

\Say[<span style="color:green;"><參數01></span>,<span style="color:green;"><參數02></span>]

**● <span style="color:green;">參數01</span>：**
您在 CSV 檔案的 **語系參數<span style="color:green;">(綠色區域)</span>** 欄位。

**● <span style="color:green;">參數02</span>：**
您在插件管理器「**[外部文本語言...](#%E2%94%80-%E8%AA%9E%E8%A8%80%E5%91%BD%E4%BB%A4%E5%B0%8D%E8%A9%B1%E6%A1%86)**」所設定的「**文本參數**」。

:::warning
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> 但需要注意的是不能有任何的空格，如真的需要有空格可以改用「_」替代空格。
:::

### ■ 呼叫多國語言文本(※保留原文做為註解的情況)
---

在原文的前面或後面加入呼叫指定的文本項目，「**\Say**」可在 **[語言命令](#%E2%94%80-%E8%AA%9E%E8%A8%80%E5%91%BD%E4%BB%A4)** 變更。

**● 文字指令：**

\Say[<span style="color:green;"><參數01></span>,<span style="color:green;">true</span>]

\Say[<span style="color:green;"><參數01></span>,<span style="color:green;"><參數02></span>,<span style="color:green;">true</span>]

**● <span style="color:green;">參數01</span>：**
您在 CSV 檔案的 **語系參數<span style="color:green;">(綠色區域)</span>** 欄位。

**● <span style="color:green;">參數02</span>：**
您在插件管理器「**[外部文本語言...](#%E2%94%80-%E8%AA%9E%E8%A8%80%E5%91%BD%E4%BB%A4%E5%B0%8D%E8%A9%B1%E6%A1%86)**」所設定的「**文本參數**」。

:::warning
<i class="fa fa-exclamation-triangle" aria-hidden="true"></i> 但需要注意的是不能有任何的空格，如真的需要有空格可以改用「_」替代空格。
:::

## ◆ 如何在 RPG Maker MV/MZ 軟體安裝來自第三方的翻譯模組

#### **1.** 在您的遊戲專案打開「插件管理器」(鍵盤快捷鍵為 <kbd>F10</kbd> )，並且在本插件的上方使用滑鼠左鍵兩下安裝來自第三方的翻譯模組。

#### **2.** 接著在本插件的「<span style="color:DimGray;">＃→翻譯插件補丁</span>」參數輸入翻譯模組的插件檔案名稱，之後的插件參數設定只要在您目前使用的第三方的翻譯模組設定即可。

:::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> **關於翻譯模組**
由於作者本身沒有很多時間做插件翻譯，所以作者公開 **翻譯用插件模板(NekoGakuen_MulitLanguage_TransMod.js)** 給其他想翻譯的人方便翻譯好直接使用，而不用再特地修改本插件，看得懂插件細節的人，再使用作者提供的插件模板進行翻譯。
:::

## ◆ 著作聲明

修改或翻譯本插件無需事前告知，如果插件有 BUG 可以回報。
本插件著作權為 [貓咪學園(NekoGakuen)](https://twitter.com/NekoGakuen) 所有。
並且保留對插件使用規則的修改與更動之權利。

**- 來源標示：**<span style="color:green;">【△ 不需要，但有的話會很感謝。**(註1)**】</span>
**- 商業營利：**<span style="color:green;">【√ 允許】</span>
**- 成人用途：**<span style="color:green;">【√ 允許】</span>

:::info
<i class="fa fa-info-circle" aria-hidden="true"></i> **註1：**
但如有註明的話，可以註明「NekoGakuen」即可。
:::

## ◆ 附註：參考資源

本次使用手冊的部分截圖，所使用的圖示素材來自「[Nicolae (Xelu) Berbece](https://twitter.com/xelubest)」所設計的免費圖示素材「[FREE Keyboard and controllers prompts pack](https://opengameart.org/content/free-keyboard-and-controllers-prompts-pack)」。

**《NekoGakuen》官方推特(X)**
https://x.com/NekoGakuen

**《NekoGakuen》官方網誌**
https://nekogakuen.blogspot.com

###### tags: `插件使用手冊` `貓咪學園` `NekoGakuen` `RPG Maker MV` `RPG Maker MZ`