Description
Modopedia is a resource-driven guidebook and in-game documentation mod for Minecraft available on Neoforge and Fabric featuring an extensive API and a wide range of out-of-the-box content. The keen eyed among you may be thinking "Well, isn't this just Patchouli?". No! Modopedia sports numerous API improvements for mod developers and gives much more freedom in creating customised content, such as:
-
Customisable textures, including the dimensions and number of pages. You control almost everything about how the book renders.
-
Ability to quickly find the page for a specific item using the "Study" key with no extra setup.
-
JSON format supporting circular dependencies and multiple categories per entry.
-
Clear error handling on a per-component level. No more nuking the entire entry!
-
Multiple templates on a single page.
-
And much, much more!
Support Development
Documentation
Modopedia's Entry JSONs are slightly less abstracted than most other book mods. Rather than working with pages, you place components either directly or by using templates. While this does take a little effort to set up initially, it provides far more extensive customisability than alternatives like Patchouli.
The GitHub Wiki can be used to view how to create books and integrate with your own mods, if something isn't covered or you need help you can also join the Discord and ask in there.
FAQs
- Can I add this to my modpack? - Of course! Just please don't redistribute the mod elsewhere without asking me first and don't claim credit for creating it.
- Can you add X thing? - Feel free to leave suggestions on the discord. I read and consider all feedback.
All Versions
+ Add Version| Name | Game version | Platforms | Published | Downloads | Actions |
|---|---|---|---|---|---|
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 | ||||
| 1d ago | 1 |
- ADDED: zh_cn translations for the multiblock previewer.
- ADDED: zh_cn translations for the multiblock previewer.
- CHANGED: Fixed FormattedStringBuilder#colour (again)
- CHANGED: Fixed FormattedStringBuilder#colour (again)
- CHANGED: Adjusted multiblock-related datagen builders.
- CHANGED: Adjusted multiblock-related datagen builders.
- CHANGED: Breaking API change to BEStateMatcher, hopefully before anyone had time to be dependent on it.
- CHANGED: Breaking API change to BEStateMatcher, hopefully before anyone had time to be dependent on it.
- FIXED: Crash on dedicated servers
- FIXED: Crash on dedicated servers
- ADDED: Multiblock preview feature. See docs to enable it.
- ADDED: New helpers and overloads for various datagen methods.
- FIXED: FormattedStringBuilder#colour truncates leading zeros from it's output
- CHANGED: Updated Javadoc formatting to be more consistent and readable.
- CHANGED: The following datagen API builders/methods have been merged and renamed:
- LargeFramedEntityBuilder#of -> FramedEntityBuilder#large
- MediumFramedEntityBuilder#of -> FramedEntityBuilder#medium
- LargeFramedImageBuilder#of -> FramedImageBuilder#large
- MediumFramedImageBuilder#of -> FramedImageBuilder#medium
- LargeFramedMultiblockBuilder#of -> FramedMultiblockBuilder#large
- MediumFramedMultiblockBuilder#of -> FramedMultiblockBuilder#medium
- LargeFramedShowcaseBuilder#of -> FramedShowcaseBuilder#large
- MediumFramedShowcaseBuilder#of -> FramedShowcaseBuilder#medium
- ADDED: Multiblock preview feature. See docs to enable it.
- ADDED: New helpers and overloads for various datagen methods.
- FIXED: FormattedStringBuilder#colour truncates leading zeros from it's output
- CHANGED: Updated Javadoc formatting to be more consistent and readable.
- CHANGED: The following datagen API builders/methods have been merged and renamed:
- LargeFramedEntityBuilder#of -> FramedEntityBuilder#large
- MediumFramedEntityBuilder#of -> FramedEntityBuilder#medium
- LargeFramedImageBuilder#of -> FramedImageBuilder#large
- MediumFramedImageBuilder#of -> FramedImageBuilder#medium
- LargeFramedMultiblockBuilder#of -> FramedMultiblockBuilder#large
- MediumFramedMultiblockBuilder#of -> FramedMultiblockBuilder#medium
- LargeFramedShowcaseBuilder#of -> FramedShowcaseBuilder#large
- MediumFramedShowcaseBuilder#of -> FramedShowcaseBuilder#medium
- ADDED:
FormattedStringBuilderoverloads for links with colours. - ADDED:
sort_numfield in category.json for deciding the ordering of categories on the landing page.
- CHANGED: Modopedia books should now show up on JEI and REI searches under the namespace they were created in (e.g. for searching
@enchanted). This feature currently only works on NeoForge.
- ADDED:
FormattedStringBuilderoverloads for links with colours. - ADDED:
sort_numfield in category.json for deciding the ordering of categories on the landing page.
- CHANGED: Modopedia books should now show up on JEI and REI searches under the namespace they were created in (e.g. for searching
@enchanted). This feature currently only works on NeoForge.
- ADDED:
FormattedStringBuilderoverloads for links with colours.
- CHANGED: Modopedia books should now show up on JEI and REI searches under the namespace they were created in (e.g. for searching
@enchanted). This feature currently only works on NeoForge.
- ADDED:
FormattedStringBuilderoverloads for links with colours.
- CHANGED: Modopedia books should now show up on JEI and REI searches under the namespace they were created in (e.g. for searching
@enchanted). This feature currently only works on NeoForge.
- ADDED: Paragraph and linebreak helper methods in
FormattedStringBuilder, this should now be shorter than using a text block for the same purpose.
- FIXED: CategoryScreens crash when trying to open a non-existent entry or child category. This now gives the appropriate warning instead.
- ADDED: Paragraph and linebreak helper methods in
FormattedStringBuilder, this should now be shorter than using a text block for the same purpose.
- FIXED: CategoryScreens crash when trying to open a non-existent entry or child category. This now gives the appropriate warning instead.
- Fixed problem where modopedia components may not be registered in time during neoforge datagen.
- Fixed problem where modopedia components may not be registered in time during neoforge datagen.
- DEPRECATED: The following features have been deprecated and marked for removal in 1.21.2. They have been removed from the documentation and replaced by their successors:
modopedia:item- replaced bymodopedia:item_gallerymodopedia:framed_item- replaced bymodopedia:framed_item_gallerymodopedia:framed_crafting_grid- replaced bymodopedia:grid_framed_item_gallery
- BREAKING: Book types are now directly passed to BookScreen. Custom book types and screens will need to be adjusted accordingly.
- ADDED:
modopedia:item_gallerycomponent, this replaces the now deprecatedmodopedia:itemcomponent. See documentation for how to use this, it's very different. - ADDED:
modopedia:grid_framed_item_gallerycomponent, this replaces the now deprecatedmodopedia:framed_crafting_gridcomponent. - ADDED:
modopedia:framed_item_gallerycomponent, this replaces the now deprecatedmodopedia:framed_itemcomponent. - ADDED:
FormattedTextBuilderfor use in datagen. - ADDED:
BookRenderContext#renderItemmethod. This should be used in place of traditional item rendering as it handles the Study keybind. - ADDED:
EntryBuildercan now directly link itself to a category during datagen.
- CHANGED: URL text formatters now display the URL on a tooltip.
- CHANGED: Click and hover events on formatted text will now work in landing and category screens.
- FIXED: Books with no subtitle will crash when trying to render their tooltip.
- DEPRECATED: The following features have been deprecated and marked for removal in 1.21.2. They have been removed from the documentation and replaced by their successors:
modopedia:item- replaced bymodopedia:item_gallerymodopedia:framed_item- replaced bymodopedia:framed_item_gallerymodopedia:framed_crafting_grid- replaced bymodopedia:grid_framed_item_gallery
- BREAKING: Book types are now directly passed to BookScreen. Custom book types and screens will need to be adjusted accordingly.
- ADDED:
modopedia:item_gallerycomponent, this replaces the now deprecatedmodopedia:itemcomponent. See documentation for how to use this, it's very different. - ADDED:
modopedia:grid_framed_item_gallerycomponent, this replaces the now deprecatedmodopedia:framed_crafting_gridcomponent. - ADDED:
modopedia:framed_item_gallerycomponent, this replaces the now deprecatedmodopedia:framed_itemcomponent. - ADDED:
FormattedTextBuilderfor use in datagen. - ADDED:
BookRenderContext#renderItemmethod. This should be used in place of traditional item rendering as it handles the Study keybind. - ADDED:
EntryBuildercan now directly link itself to a category during datagen.
- CHANGED: URL text formatters now display the URL on a tooltip.
- CHANGED: Click and hover events on formatted text will now work in landing and category screens.
- FIXED: Books with no subtitle will crash when trying to render their tooltip.
- CHANGED: Updated Chinese localisation.
- FIXED: Creative menu crash from having a book registered twice. Oops.
- FIXED: Datagen builders do not create their registryops in the correct way.
- CHANGED: Updated Chinese localisation.
- FIXED: Creative menu crash from having a book registered twice. Oops.
- FIXED: Datagen builders do not create their registryops in the correct way.
- CHANGED: Cooking and double cooking page templates now use the title "Cooking Recipe" instead of "Recipe"
- CHANGED: Entity/Multiblock page templates (and by extension block pages) now automatically set their width to the width of the page. The
widthfield they use has been removed.
- FIXED: Page Components which use a widget (e.g. image gallery buttons) do not create their widget when used as part of a template.
- CHANGED: Cooking and double cooking page templates now use the title "Cooking Recipe" instead of "Recipe"
- CHANGED: Entity/Multiblock page templates (and by extension block pages) now automatically set their width to the width of the page. The
widthfield they use has been removed.
- FIXED: Page Components which use a widget (e.g. image gallery buttons) do not create their widget when used as part of a template.
- CHANGED: Datagen has had some small breaking changes, update your code.
- CHANGED: Added hyphenated word-splitting exemptions for specific languages such as Chinese and Japanese.
- CHANGED: PageComponents now have their language code passed in.
- FIXED: Scale of Multiblock and Entity displays not having the same effect as expected.
- FIXED: Word splitting loses a character
- FIXED: Async ordering issue during book loading.
- CHANGED: Datagen has had some small breaking changes, update your code.
- CHANGED: Added hyphenated word-splitting exemptions for specific languages such as Chinese and Japanese.
- CHANGED: PageComponents now have their language code passed in.
- FIXED: Scale of Multiblock and Entity displays not having the same effect as expected.
- FIXED: Word splitting loses a character
- FIXED: Async ordering issue during book loading.
- FIXED: Fabric crashing (again)
- FIXED: Fabric crashing (again)