Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

6.0.0 New Icon Documentation #11

Open
mysticdrew opened this issue Feb 25, 2023 · 1 comment
Open

6.0.0 New Icon Documentation #11

mysticdrew opened this issue Feb 25, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@mysticdrew
Copy link
Member

mysticdrew commented Feb 25, 2023

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
Copy link
Member Author

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.

@mysticdrew mysticdrew added the documentation Improvements or additions to documentation label Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant