EricMao's Mod Instruction Framework

Have you ever installed a content-rich mod, only to find yourself unsure where to begin?
Which research projects should you unlock first? How do you use the new facilities? How are its complex systems supposed to work?

“EricMao's Mod Instruction Framework” is a framework that allows mod authors to create in-game manuals for their RimWorld mods. With this framework, players can read mod introductions, gameplay guides, and detailed information without leaving the game or repeatedly checking the Steam Workshop page.

The Mod Instructions menu can be opened from the menu bar at the bottom of the game screen. It automatically lists all installed mods that include manuals. Each mod can contain multiple manuals covering different subjects, and the manuals can support multiple languages. Links can also be added to item information windows, research pages, and other locations, allowing players to open a specific manual directly.

This mod also includes a graphical “Mod Instruction Editor.” Even if you are unfamiliar with XML, you can use the editor to create your own manuals.

The editor supports:
-Adding, removing, and rearranging manuals.
-Editing titles and content in different languages.
-Adding text, images, and blank spacing.
-Applying bold, italic, and different text colors.
-Assigning separate images to different languages.
-Setting manual thumbnails.
-Linking manuals to ThingDefs or ResearchProjectDefs.
-Packaging manuals directly into a target mod folder.
-Exporting manuals as independently publishable manual patch mods.
-Saving projects for future editing.

You can find the editor and its instructions in the Tools folder inside the mod directory.
Who is this framework for?


This framework is suitable for:
-Mod authors who want to provide complete in-game tutorials.
-Large mods featuring complex systems or extensive new content.
-Enthusiastic players who want to write guides and instructions for other mods.
-Translation teams that want to create multilingual in-game documentation.
-Manuals can be included directly in the original mod or published separately as a manual patch mod. This means that even if you are not the original mod author, you can still create more complete in-game guides for the mods you enjoy.


The Mod Instruction Editor interface currently includes:
-Traditional Chinese
-English