Assets

Assets are used to display images of items, blocks and other project content across the website.

These can be used as part of crafting recipes, sidebar information or custom components.

Placement

• <root>
  • assets
    • <namespace>
      • gui
        • electric_furnace.png
        • progress.gif
      • item
        • example_item.png// Referenced via <namespace>:item/example_item

Format

Assets are identified using resource locations  using the same syntax as in the game itself. It’s recommened to match asset names with the in-game IDs of the objects they belong to.

Rendered project assets including both items and blocks should be placed under assets/(modid) inside the documentation directory, where modid is the namespace of each texture you wish to provide.

By default, resource locations point to .png files. A custom file extension can be appended to the resource location if the file is of another format.

The name of the file is up to your choice.

Examples

• examplemod:overview - Displays <root>/assets/examplemod/overview.png

• examplemod:item/generator - Displays <root>/assets/examplemod/item/generator.png

• examplemod:gui/grinding.gif - Displays <root>/assets/examplemod/gui/grinding.gif

• minecraft:crafting_table or crafting_table - Displays a 3D render of the Crafting table

Usage

You’ll encounter assets being used for various different purposes across the wiki depending on the feature.

The most common use cases include:

• Displaying images anywhere in pages

• Providing icons for pages by specifying the icon frontmatter attribute

• Providing icons for content pages, sourced automatically using the page’s id frontmatter attribute as the asset location

• Showing items in recipes

• Playing audio files

Note on item assets

The wiki uses a fixed asset location for displaying inventory renders of items in certain places, e.g. mapping item IDs to assets. Typical usage includes content page icons, default infobox layouts, recipes and recipe usage prefab components.

In the case of content pages and the infobox, default locations can be overriden in the page’s frontmatter. However, for built-in components, the wiki must be able to find a suitable item asset to display knowing only its ID.

The wiki will look for these assets under <modid>:item/<item_id>, which maps to <root>/assets/<modid>/item/<item_id> in your project.

For example, to display examplemod:generator, the image will be placed under <root>/assets/examplemod/item/generator.png.

Allowed file types

For security reasons, only certain file types can be included in wiki projects (regardless of the location).

Currently, the following formats are supported:

• MDX documents: .mdx
• JSON data: .json
• Images: .png, .jpg, .jpeg, .webp, .gif, .svg
• Audio: .ogg, .mp3, .wav

If you want to include a file that is not included here, feel free to reach out to us.