search

TeamJM / journeymap-docs

The JourneyMap Documentation using MKDocs
https://teamjm.github.io/journeymap-docs/
GNU Lesser General Public License v2.1
2 stars 3 forks source link

6.0.0 New Icon Documentation #11

Open mysticdrew opened 1 year ago

mysticdrew commented 1 year ago

Instructions:

To include a custom mob icon in your resource pack, you have to put a PNG image on the following path: /assets/journeymap/icon/entity/{mod_id}/{mob_name}.png

{mod_id} has to be the ID of the mod to which the mob belongs, or minecraft if it is a native mob of the game. {mob_name} is the name of the mob.

For example: /assets/journeymap/icon/entity/minecraft/creeper.png

The recommended size for the icon is 16x16. It can be of any size, but to be shown correctly it has to fit into the marker's circle. As a reference you can use the following image:

icon_mask

Any size that fits inside the circle will work. If you use a larger image, be sure to put transparent pixels in the corners so that they do not protrude outside the circle.

As a reference you can see the icons automatically generated by JourneyMap in the folder /journeymap/icon/entity/

Icons can be manually added by putting them in the /journeymap/icon/entity/{mod_id}/ without using a resource pack, this however will require a client restart.

mysticdrew commented 1 year ago

setting icons in the options now has an "outlined" option. resource packs can include a png with "_outline.png" suffix and then outline option will pick it up. But it is optional, if an outlined variant does not exist it will use the available one.

For example. Journeymap generates creeper.png and creeper_outlined.png if a resource pack replaces creeper.png but not creeper_outlined.png setting the setting to outline icons will use creeper.png.

Hope this makes sense.