Added a FAQ for common questions

Amaury Carrade 2020-07-03 20:56:17 +02:00
parent 841b81e18e
commit d0445b546c

26
FAQ.md Normal file

@ -0,0 +1,26 @@
Answers to frequently asked questions. Please check these before asking on Discord, Spigot, GitHub, or others!
### What kind of link can I 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 selecting “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](https://imgur.com/upload?beta), 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](https://imgur.com/upload?beta), for example.
The same tip apply for any error message starting with `HTTP error`, except for 404, as explained above.