快速起步

本条目可作为了解如何开始制作自己的Patchouli手册的快速指导,阅读并仔细跟随文中说明使用!


0. 安装 Patchouli

很显然的事情。不过针对Modder而言,可以将它作为你mod项目的一个lib加载或直接丢进你workspace下的mods文件夹内。


1. 定位你的patchouli_books目录

你添加的手册和它们的内容都会存放在你的patchouli_books目录下,所以你需要找到它。

对于整合包作者,它会在你整合包主目录下生成。(与mods, config等在同一目录)注意:你需要启动一次安装好patchouli的整合包才会自动生成(或者你自己新建一个,没有问题)

对于mod制作者,你需要在/assets/_你MOD的modid_ 或  /data/_你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了。