ImageOnMap
Have you ever wanted to view an image on a map ingame? ImageOnMap allows you to do it! (Inspired by ImgMap)
Features
ImageOnMap allows you to load a picture from the Internet to a Minecraft map.
- Loads an image from a URL onto a map. PNG, JPEG and GIF are supported.
- These images will be saved on your server and reloaded at restart.
- Big pictures will be cut automatically into several parts! As example, a 1024x1024 picture will be cut in 16 maps.
- Your image will be centered.
- You can put your map in an item frame.
This plugin is a free software lisensed under the GNU General Public License (version 3 or above). The source code is published on GitHub.
The latest version is only compatible with Minecraft 1.15+.
- For Minecraft 1.13 and 1.14, use 4.0-pre1.
- For older versions, please use ImageOnMap 3.1 (warning: unchecked by the BukkitDev staff—if you're unsure, use 3.0 here in BukkitDev, it's the same but without permissions).
Support and bug requests
If you need help with ImageOnMap, the preferred way is our Discord server. We speak English and French. You should read the FAQ first!
If you want to report a bug or suggest features, by far the best option for us is GitHub issues, which you should use whenever possible. If you absolutely can't use GitHub, use the support options above.
We're a team behind ImageOnMap (and others), and private messages from Spigot can only be read by one person. So you should not send help requests, suggestions or bug reports using Spigot or BukkitDev PMs. Any PM received after June 28, 2020 with any of these topics will be ignored.
Quick guide
- Ensure that you have a free slot in your inventory, as ImageOnMap will give you a map.
- Type /tomap URL, where URL is a link to the picture you want to render (see the section below).
- Enjoy your picture! You can place it in an item frame to make a nice poster if you want.
German speakers, you can watch this video (thanks to StarlessMiner)
English speakers? (thanks to Arma)
Another tutorial in English (thanks to ltjim007)
Commands and Permissions
/tomap <url>
Renders an image and gives a map to the player with it.
- This command can only be used by a player.
- The link must be complete, do not forget that the chat limit is 240 characters.
- You can use an URL shortener like tinyURL or bitly.
- If you want a picture in one map, type resize after the link.
- If you want to resize to multiple maps, add the witth and height after resize: e.g. /tomap url resize 2 4
- You can change the scaling method by replacing the resize keyword in the /tomap command by:
- resize-stretched to stretch the image to the surface (the image could be distorted); or
- resize-covered to ensure the image covers the whole surface (the image will never be distorted, but some parts may be lost near the borders).
- Permission: imageonmap.new (or imageonmap.userender—legacy, but will be kept in the plugin).
/maps
Opens a GUI to see, retrieve and manage the user's maps.
- This command can only be used by a player.
- Opens a GUI listing all the maps in a paginated view.
- A book is displayed too to see some usage statistics (maps created, quotas).
- A user can retrieve a map by left-clicking it, or manage it by right-clicking.
- Maps can be renamed (for organization), deleted (but they won't render in-game anymore!), or partially retrieved (for posters maps containing more than one map).
- Permission: imageonmap.list, plus imageonmap.get, imageonmap.rename and imageonmap.delete for actions into the GUI.
/maptool <new|list|get|delete|explore|migrate>
Main command to manage the maps. The less used in everyday usage, too.
- The commands names are pretty obvious.
- /maptool new is an alias of /tomap.
- /maptool explore is an alias of /maps.
- /maptool migrate migrates the old maps when you upgrade from IoM <= 2.7 to IoM 3.0. You HAVE TO execute this command to retrieve all maps when you do such a migration.
- Permissions:
- imageonmap.new for /maptool new;
- imageonmap.list for both /maptool list and /maptool explore;
- imageonmap.get for /maptool get;
- imageonmap.delete for /maptool delete;
- imageonmap.administrative for /maptool migrate.
About the permissions
All permissions are by default granted to everyone, with the exception of imageonmap.administrative. We believe that in most cases, servers administrators want to give the availability to create images on maps to every player.
Negate a permission using a plugin manager to remove it, if you want to restrict this possibility to a set of users.
You can grant imageonmap.* to users, as this permission is a shortcut for all user permissions (excluding imageonmap.administrative).
Configuration
# Plugin language. Empty: system language.
# Available: en_US (default, fallback) and fr_FR.
lang:
# Allows collection of anonymous statistics on plugin environment and usage
# The statistics are publicly visible here: https://bstats.org/plugin/bukkit/ImageOnMap
collect-data: true
# Images rendered on maps consume Minecraft maps ID, and there are only 32 767 of them.
# You can limit the maximum number of maps a player, or the whole server, can use with ImageOnMap.
# 0 means unlimited.
map-global-limit: 0
map-player-limit: 0
Changelog
3.0
The 3.0 release is a complete rewrite of the original ImageOnMap plugin, now based on zLib, which adds many features and fixes many bugs.
This new version is not compatible with the older ones, so your older maps will not be loaded. Run the/maptool migrate command (as op or in the console) in order to get them back in this new version.
You will find amongst the new features:
- New Splatter maps, making it easy to deploy and remove big posters in one click!
- No more item tags when maps are put in item frames!
- Internationalization support (only french and English are supported, for now; contributions are welcome)
- Map Quotas (for players and the whole server)
- A new map Manager (based on an inventory interface), to list, rename, get and delete your maps
- Improvements on the commands system (integrated help and autocompletion)
- Asynchronous maps rendering (your server won't freeze anymore when rendering big maps, and you can queue multiple map renderings !)
- UUID management (which requires to run /maptool migrate)
3.1
- Fixed permissions support by adding a full set of permissions for every action of the plugin.
4.0 pre-release 1
- Added 1.13.2 and 1.14 compatibility
- Dropped compatibility with 1.12 and lower
- Improved some UIs
- Added support for images' resize to a specific size: you can do /tomap https://url/image.png resize 2 2 to get a 2×2 frames image.
- Status messages are sent in the action bar instead of the chat
- Added back statistics (you can opt-out in plugins/bStats/config.yml)
- Added an update checker
4.0 pre-release 2
- 1.15 compatibility (now building against a 1.15-compatible zLib version).
- This version is only compatible with Minecraft 1.15 and later—for older Minecraft versions, please use 4.0-pre1 or older.
- Improved some translations in French (thanks to Gabriel C.).
4.0
- You can now place a map on the ground or on a ceiling.
- Languages with non-english characters now display correctly (fixed UTF-8 encoding bug).
- Splatter maps no longer throw an exception when placed.
- When a player place a splatter map, other players in the same area see it entirely, including the bottom-left corner.
- Added Russian and German translations (thx to Danechek and squeezer).
4.2.0 The permission and cliffhanger update ⋅ Part I
- 1.17 support.
- Permissions to limit the number of map/image used/owned is now available. (permissions imageonmap.mapLimit.XX and imageonmap.imageLimit.XX where XX is an integer and will define the limit allowed for the player).
- Added a whitelist for trusted image hosting websites. Add an images-hostnames-whitelist list in config.yml, and write every URL prefix you want to allow. If you want to allow everything, remove the images-hostnames-whitelist list entirely, or empty it. There is also a permission to ignore the allow list: imageonmap.bypasswhitelist.
Code (YAML):images-hostnames-whitelist:
- i.imgur.com
- cdn.discord.com - Images are now protected against non player based interaction. (Bye bye sneaky skeleton that used to grief art!)
- Now by default when deploying a map the item frame turn invisible and returned to visible hen removing the map from the frame (there is a permission to allow this behavior: imageonmap.placeinvisiblesplattermap).
- Bug fixes & optimizations.
- Dropped migrator (no more error when reloading or when sometimes loading the server).
- Fixed an issue when resizing with resize 0 0.
- Fixed a map loading issue. (map did not render at all if they weren't in a player inventory.
- Added a fix for map loading on paper. (map did not render fully on paper).
4.2.1 The permission and cliffhanger update ⋅ Part II
- 1.18 support.
- Fixed a lag issue caused by the map loading changes of 4.2.0.
- Fixed an issue with map part not working properly.
- Fixed an issue in survival where an incorrect amount of map were consumed.
- Fixed an issue where image map folder was not created and cause issues.
Data collection
We use bStats to collect basic data about the usage of this plugin*. This can be disabled in the plugins/bStats/config.yml file.
@Kino876
Hmm you use v3.0 right ? :p Yes, it's a debug message that i've forgotten to remove.. sorry. It can make lag if you have set "send-entire-map" in confyg.yml to value other than 0 (because it send to player all maps loaded).
I don't know sure, but... it's possible that this plugin make some lag when a player join to the server?...
The console shows this message each time a player join: [ImageOnMap] Entrée d'un joueur en jeu
I think this could be a "debug message" that you have forgotten enabled?
@JavaRyan
Yes.
Is this multithreaded? I don't want my whole server to crash from rendering an image.
@Etsija
Why not ! I've uploaded a beta (waiting for bukkit team to validate), please test it and tell me wha'ts wrong.
OK thanks for the info Mooribus. I'll have a look at the corresponding Bukkit code then.
And meanwhile, I think I will produce a 256-color example figure (with squares in different colours) and render it with your plugin. As a result, I can create a figure where those two figures are put side by side so that the users of this plugin could then compare and maybe decide which colours to avoid in their figures (those which map badly, for example the beige skin colour).
If I get the figure done, maybe you could link it to your plugin description, to help the players when choosing colours to use in their figures?
- - -
Thanks for the excellent plugin btw, been waiting for such for 2 years now! Keep up with the good work.
Wow.. So much comments ! :) @Etsija
Yes, I'll better handle exceptions for the next update. Also, the plugin will print a warning with https link - it will be clearer. For the color, it's not really my plugin that handle this - It just uses the bukkit builtin function Canvas.drawimage(). Thanks for your support. :)
@Etsija
Did a ctrl+f and found it. Honestly didn't see it after looking over it a couple times... Sorry about that.
@Flexo013
Good to hear that solved your problem. This plugin does its best to reach the picture, and on some occasions it can even access pictures behind https://... URLs (for example, all Dropbox Public folder links are https://... but they can still be accessed directly, because a login is not needed). When it cannot, however, it does seem to want to produce Java errors to the console instead of informing the player, which imho would be a more elegant way of working.
@Etsija
Thanks, that was indeed the issue. I fixed it by downloading the image and then uploading it to imgur.
@Flexo013
You are trying to render a resized image, right? Judging from the line of code shown in your Java error paste I think that's what you are trying to do. Are you sure your picture exists and the link is not broken? And, the HTTP address isn't by accident a https....?
@Mooribus: I seem to also get Java errors whenever the plugin can't reach the figure I'm trying to render. Maybe you could write something clever to these exceptional situations to warn the player about not reaching the URL properly, instead of just throwing Java errors to the console. Maybe something to rewrite on ImageRenderedThread.java, around the main try...catch loop at the run() method of the thread, to also inform the player the plugin could not find or reach the figure the player wants to render.
@Liger_XT5
See the description above. The permission for this plugin is "imageonmap.userender".
- - -
@Mooribus: can you explain the colour restrictions of the images? I'm testing this great plugin with people's faces, but human skin seems to get weird reddish colour. Are the colours of the pictures somehow restricted to the colours of Minecraft itself? I read everything I found about Minecraft maps from Minepedia, but couldn't find out anything about the colours.
Actually, you could create a test picture for the sole purpose of testing how the colour mapping goes in game and paste it to the description. That would tell people what kind of colour mapping they can expect with their pictures. Could save a lot of trial-and-error-time to create beautiful pictures.
I keep getting this error message when I try to render a map:
DONE: Permission support
What's the permissions may I ask?
This plugin is amazing. I tried developing a plugin like this, but I didn't have much luck, so I'm glad that I found this. Keep up the great work. =)
@Cseraphi
Images are destroyed when you run /maptool delete. The only thing that is not deleted is the .dat file on your world folder. However, image are named with the ID of the map that use it, so if you have an image named "map123" search "123" in the map.yml :)
@MachoMancha
Put your map into a chest. In the next update you will be able to not name map. :)
It seems that once imported, images remain in the plugin folder even if all the maps that used them are destroyed. I'd like to periodically delete all the image files that aren't actually being used, since the amount of disk space being used is getting large.
Is there a good way to safely delete the files in the Images/ subdirectory? How can I determine if there are live maps still using them? What happens if I delete a "map" from Images/ while the corresponding map is still hanging around in-game?
I'm also having a problem w/ others not seeing my image. Only I can see it for some reason. I'm on craftbukkit 1.7.2.
Is there a way to hide the large text when hovering the map on an item frame in game?
@ltjim007
Added. :)