Patchouli Wiki translation Getting Start Patchouli Minecraft Game

Start quickly

This entry can be used as a fast guidance for how to understand how to start making its own Patchouli manual, read and carefully follow the text to explain it!

0. Install patchouli

Obviously.However, for MODDER, you can load it as a lib project of your MOD project or throw it directly into the Mods folder under your workspace.

1. Position your patchouli_Books directory

The manuals you add and their content will be stored in your patchouli_Books directory, so you need to find it.

For the integration package author, it will be generated in your integrated package main directory.(At the same directory as Mods, Config, etc.) Note: You need to start a integration package installed once installed Patchouli to automatically generate it (or you create one by yourself, there is no problem)

For the MOD producer, you need to create a new Patchouli_Books folder in/asseets/_ your mod of modid_ or/data/_ your modid_ directory, which will not be generated automatically.

2. Create your folder structure

After finding or creating the Patchouli_Books folder, a name is for your manual.The manual folder can only be named using a lowercase letter and the lower line "_".

This is purely an internal name, so you can just get any name, or you are too lazy to use the name to use "BOOK" and no one will mind.

After determining the internal name of the manual, create some folders and files in the Patchouli_Books directory. It is best to look like this:

patchouli_Books (head directory)

Yourbookname Handbook Internal Name (Folder)

Book.json book.json (empty file)

En_us (folder)

ENTRIES (empty folder)

Categories (empty folder)

Templates (empty folder)

You can add any number of manuals, or even under the same MOD or the same integration package.

Usually each manual should have different IDs.

In the game, each manual will be registered in the ID of "your MOD Modid: internal name" or "patchouli: internal name of the manual" format, and the latter's manual is usually loaded as the content of the integrated package.

It should be noted that the "EN_US" folder you created represents a manual you are creating an English version.

The "EN_US" folder will always be loaded as the core content of the manual, so although you are not used to in English, you must also put the main content into this.

Any translator may need to create the language they use and rewrite any files they need.

According to changes in the language of the game, they will be carried automatically.

Translator Note: Do not add files that are not rewritten in other language folders in other language folders.

3. Fill in book.json

Use your favorite editor to open your book.json, and then fill in the following content:

{{

"name": "book name",

"LANDING_TEXT": "LANDINT Text",

"version": 1

}

"Book Name" is the name of your book will be displayed, and "LANDING Text" will be displayed on the left page of the manual directory in the game.

The version of the Version object will be displayed as the first edition of the manual.

Every time you update the manual, you should also update the version number of the manual.

Of course, as a MODDER, you can also use the localized entry keyword to set the name and Landing Text.4. In -game inspection

Open the game to check your book is not in the game.Unless you have set it up, it should be in the miscellaneous creative column.But you can still search for it.

If you can't find it, check whether Patchouli is successfully loaded or there are errors in the log file.

After that, all the contents can be carried out without closing the game, so the next step can be made at any time.

5. Add content

It's time to add some dry goods to your manual.Open the EN_US folder in your folder, and create a new folder and file according to the following content:

en_us

ENTRIES (folder)

Test (folder)

Test_entry.json (empty file)

Categories (folder)

Test_category.json (empty file)

Templates (empty folder)

Open the testry.json and test_category.json, and add it according to the following content:

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!"

}

]

}

test_category.json:

{{

"name": "test category",

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

"icon": "Minecraft: Writable_Book"

}

Save the file and go back to the game to open your manual.SHIFT plus a left -click pencil button in the lower left corner.

After you do this, it will reload the contents of the manual, and then you should be able to see the newly added Category and Entry.