Answers to frequently asked questions. Please check these before asking on Discord, Spigot, GitHub, or others!
What kind of link I can use with /tomap
?๐
You can use any publicly-accessible link from the internet that is a direct link to a PNG, JPG, JPEG or GIF file.
Some examples:
- this link, a direct link to an image, is valid:
https://upload.wikimedia.org/wikipedia/commons/2/21/Acme_klein_bottle.jpg
- this link, a link to a Wikimedia Commons page for the image, is not, as it's a link to a webpage containing the image:
https://commons.wikimedia.org/wiki/File:Acme_klein_bottle.jpg
- this link, a direct link to an image, is valid:
https://i.imgur.com/MT0Ruv9.png
- this link, a link to the imgur webpage containing the image, is not:
https://imgur.com/MT0Ruv9
If the /tomap
command errors with โThe given URL is not a valid imageโ, you probably gave a wrong link, to something else than a image directly.
To check that, make sure there is no webpage around the image. You can also right-click the image you want and select โCopy image URLโ (or similar) to get the direct link to the image in your clipboard.
I get HTTP error: 404 Not Found
. What does it means and what can I do?๐
This means ImageOnMap was unable to find an image at the URL you given. Double-check the spelling, and ensure the image still exist. If nothing work, you can try to re-host the file somewhere elseโyou can use imgur, for example.
What about HTTP error: 403 Forbidden
?๐
When you import an image using /tomap
, ImageOnMap asks the image's host to get the file so it can display it on your Minecraft server. This error means the web server said โsorry but no, I will not give you this imageโ. That's not very nice.
Although we have added some workarounds to avoid this problem in common cases, ImageOnMap cannot force a web server to send the file if it is a bit stubborn. In this case, your only option is to re-host the image you want to send. You can use imgur, for example.
The same tip apply for any error message starting with HTTP error
, except for 404, as explained above.
Can I send GIFs?๐
Yes, but they won't animate.
I sent a big image and ImageOnMap gave me a โsplatter mapโ. What's that, and how can I use it?๐
To display big images on a server using maps, you'll have to place a lot of maps together on a wall, with a small part of the image on everyone of them. That's boring.
A splatter map will do that for you: it contains as many maps as needed to render the image you sent. To use them, place on a wall, a floor or a ceiling, as many item frames as needed (the amount required is written on the splatter map's tooltip), then place the map like any map on the bottom-left corner of the item frames. ImageOnMap will place all other maps for you.
To remove the whole poster at once, remove any map from it while sneaking.
Can I resize the image automatically?๐
Yes.
- If you want to resize the image so it fit in a single map, add
resize
at the end of the command:/tomap <url> resize
. - If you want the image to cover the whole frame, you have two options:
- you can stretch the image over the map (will distort it!) using
/tomap <url> resize-stretched
; - you can cover the whole map without distortion by zooming the image until no blank margin is left (will lose some borders of the image) using
/tomap <url> resize-covered
.
- you can stretch the image over the map (will distort it!) using
All of this is to resize the image to a single map. If you want to resize it to multiple maps, add the width and height at the end. As example, if you want to resize an image to a 4ร2 blocs surface (width ร height), ensuring the whole surface is covered without distortion, use /tomap <url> resize-covered 4 2
.
I want to craft images specifically for Minecraft. What is the corresponding size of a single map?๐
128px ร 128px.
Colours are bad! What can I do?๐
Sadly, Minecraft cannot render all colours. We are limited to a small subset of colours listed on this page. We try to approximate colors as best as we can but we're aware that's not always perfect.
The next version will feature dithering, a technical process to optimise the colours used to render the map. That will enhance the overall quality of all images, including past ones.
ImageOnMap is way too open. Can I restrict its usage?๐
Yes, if your permissions plugin allows to negate permissions (all of them probably support that). To prevent players to create new images, negate the imageonmap.new
permission. In most cases, give the -imageonmap.new
permission to do that.
ImageOnMap is open to every player by default because we want the plugin to be usable directly, even without a permissions plugin.
ImageOnMap say there is not enough place for a splatter map, but there is and the required size is not consistant๐
It looks like ImageOnMap index was somehow corrupted. This can happen when the server is badly stopped (e.g. killed). An example is below: the size on the splatter map and on the error message doesn't match.
This seems to be a Bukkit bug we struggle to fix, but for you, the simplest fix is to render a huge map once (a map you won't use), and that rendering should repair ImageOnMap index. Run, as a player:
/tomap https://dev.zcraft.fr/logo.png resize 50 50
and re-render the previously non-working map.
When I place an image, every other player in the area cannot see the bottom-left map.๐
If other players leave the area then go back to it, they should see the whole image. Players must unload the area on their client, so they must go further than the server's rendering distance (usually, 300 blocks is enough).
We hope to find a fix for this, but at least, it's only when the map is placed.
Server software questions๐
What server softwares are supported?๐
We support Spigot-based server softwares, i.e. Spigot, Paper, and their forks. We will make updates to support changes and fix bugs in these softwares.
Other server softwares are not supported. Alternative Bukkit implementations may work if the implementation is correct, but there is no guarantee, and we won't update ImageOnMap to fix bugs on these as it would be too much work for us to handle. Also, as we hook with the native Minecraft server itself, alternative implementation without NMS accessible like Spigot-based servers probably won't work correctly.
This being said, if you want to contribute to ImageOnMap to improve compatibility for a non-supported server software, we will happily accept your contributions.
Is Mohist (the Forge + Bukkit server software) supported?๐
No, as it's an alternative Bukkit implementation (see above). Their implementation for maps handling is incomplete (as of May 2021), so ImageOnMap will probably not work on this platform. If you want to contribute to improve Mohist support, feel free. You can also ask Mohist developers to improve the maps APIs, or contribute yourself to Mohist.
Host-specific questions๐
I'm using Minehut and ImageOnMap doesn't work.๐
Minehut, a Minecraft server hosting plateform, made some updates around April 2nd, 2021 breaking pluralization on ImageOnMap translation system. As a consequence, ImageOnMap was unable to run. Actually, all QuartzLib-based plugins are affected, as they share the same translation components.
For ImageOnMap, Minehut disabled our translations system as a hotfix. We intend to fix this for everyone in an upcoming version (either 4.1 or 4.1.1), with degraded pluralization handling if the standard pluralization tools cannot be used.
I'm using Minehut and ImageOnMap miss some features.๐
It looks like Minehut use a fork of ImageOnMap, instead of the version we build. In their version, internationalization is disabled: you won't be able to use ImageOnMap in all languages supported; only English remain.
We intend to fix this for everyone in an upcoming version (either 4.1 or 4.1.1).
My link doesn't work on PloudOS.๐
You can only use imgur, due to PloudOS' security policies