Subscribe to download
Rim2Markdown

Export in-game descriptions of animals, plants, weapons, apparel and items as Markdown files. This format is supported by many online wikis such as GitHub, so you can easily use this tool to create a wiki of your mod. You can also keep them as an offline wiki for your modlist for your own use.


1) Rim2Markdown generates files for every mod in your modlist. Choose the mods you want to document, and launch the game with just them.
2) Enable development mode.
3) Start a dev quicktest game.
4) Open the debug actions menu.
5) In the Rim2Markdown category, press the Generate Markdown button.
6) Wait. Wait some more.
7) When the game finally starts working again, disregard the absolute mess created in the map.
8) Your Markdown files are ready!

The mod will generate a separate folder for each one of your mods. Each folder will contain separate markdown files for animals, plants, weapons and so on.

On Linux, the generated files can be found at /tmp/rim2markdown. On Windows 10, they can be found at C:\Users\YOUR_USER\AppData\Local\Temp\rim2markdown.


Rim2Markdown shows the same data as the in-game "View information" window. Any extra information added by mods in your modlist will show up as well. As a result of this, Rim2Markdown should be compatible with all mods.


Q: Can I see examples of the results?**

A: You can find some in the following pages of the wiki for the Biomes! Prehistoric mod.