快速起步

本條目可作為了解如何開始制作自己的Patchouli手冊的快速指導,閱讀并仔細跟隨文中說明使用!


0. 安裝 Patchouli

很顯然的事情。不過針對Modder而言,可以將它作為你mod項目的一個lib加載或直接丟進你workspace下的mods文件夾內。


1. 定位你的patchouli_books目錄

你添加的手冊和它們的內容都會存放在你的patchouli_books目錄下,所以你需要找到它。

對于整合包作者,它會在你整合包主目錄下生成。(與mods, config等在同一目錄)注意:你需要啟動一次安裝好patchouli的整合包才會自動生成(或者你自己新建一個,沒有問題)

對于Modder,你需要在/assets/你MOD的modid 目錄下新建一個patchouli_books文件夾,它不會自動生成。


2. 創建你的文件夾結構

找到或創建好patchouli_books文件夾之后,為你的手冊起一個名字。手冊文件夾只能使用小寫字母和下劃線“_”命名。

這純粹是一個內部名,所以你隨便起啥名字都可以,或者你懶得起名字只用“book”都沒有人會介意。

決定好手冊的內部名之后,在patchouli_books目錄下新建一些文件夾和文件,最好看起來會像這樣:

patchouli_books(頭目錄)

    YOURBOOKNAME 手冊內部名(文件夾)

        book.json book.json(空文件)

        en_us(文件夾)

            entries (空文件夾)

            categories (空文件夾)

            templates(空文件夾)

你可以添加任意數量的手冊,甚至是同一Mod或同一整合包下也是允許的。

通常每一本手冊都應該有不同的ID。

在游戲內,每一本手冊都會以"你Mod的modid:你書的內部名"或"patchouli:手冊內部名"格式的ID注冊,后者的手冊通常是作為整合包內容加載的。

需要注意的是,你創建的 "en_us" 文件夾代表著你正在創建一本英語版本的手冊。

"en_us" 文件夾會一直作為手冊的核心內容加載,所以盡管你不是很習慣用英語的話也要把主內容放進這里面。

任何翻譯者都可能需要自己創建它們使用的語言并重寫任意它們需要的文件。

根據游戲語言變化,它們會自動載入。

翻譯者注意:請不要在其他語言文件夾里加入并非重寫于en_us的文件。


3. 填寫book.json

用你最喜歡的編輯器打開你的book.json,然后將下面的內容填進去:

{

"name": "BOOK NAME",

"landing_text": "LANDING TEXT",

"version": 1

}

"BOOK NAME"是你的書籍會顯示出來的名字,"LANDING TEXT"在游戲內會顯示在手冊目錄的左側頁面。

version對象里會顯示這是手冊的第幾版。

每次更新手冊的時候,你應該也更新一下手冊的版本號。

當然,作為Modder來說同樣可以使用本地化條目關鍵字來設置名字和landing text。


4. 游戲內檢查

打開游戲來檢查一下你的書在不在游戲里。除非你特別設置過,它應該就會在雜項創造欄里面。不過你還是可以搜索一下來找到它。

如果找不到的話,檢查一下patchouli是否成功加載或log文件里面有沒有錯誤。

在此之后的所有內容都可以在不關閉游戲的情況下進行熱載入,因此可以隨時進行下一步編輯。



5. 加入內容

是時候為你的手冊加入些干貨了。打開你手冊文件夾內的en_us文件夾,按照下面的內容新建文件夾和文件:

en_us 

      entries (文件夾) 

            test (文件夾) 

              test_entry.json (空文件)

     categories (文件夾) 

            test_category.json (空文件)

     templates (空文件夾)

打開test_entry.json和test_category.json,按照下面的內容補充進去:

test_entry.json:

{

    "name": "Test Entry",

    "icon": "minecraft:writable_book",

    "category": "test_category",

    "pages": [

        {

            "type": "text",

            "text": "This is a test entry, but it should show up!"

        }

    ]

}

test_category.json:

{

"name": "Test Category",

"description": "This is a test category for testing!",

"icon": "minecraft:writable_book"

}


保存文件,回到游戲內打開你的手冊。Shift加左鍵單擊在左下角的鉛筆按鈕。

你這樣做之后,它會重新加載手冊的內容,然后你就應該可以看見新加入的category和entry了。