Custom Images icon

Custom Images -----

Load custom images into Minecraft



The title says it all. I decided randomly to make a plugin that could load custom images into Minecraft since I didn't see anything similar readily available. This started off as a fling project that took me about a day to write, but seems to have gained a good amount of popularity.

Therefore, I have rewritten it from the ground up to have native support of all 1.8+ Minecraft versions and use packet based entities for an entirely new experience.

Basic Information
You can load any image doesn't matter the size (within reason), however, it should be kept in mind that all blocks are 128x128 pixels. So, if your image is massive then it may take a lot of blocks to display and may also lag the client.

On that note, images are rendered better if they are in increments of 128 pixels, but it doesn't make too much of a difference since it is resized in the background to fit regardless. These images below are examples of random images that I loaded into the game to be displayed.

Any image format that Java can support is also supported.
However, types other than PNG or JPG/JPEG may not be displayed in the list command.


Basic Example.png

To add an image without clicking a block, hold an item in your hand when creating the image and right click anywhere in the air; the image will be placed in front of you.

Horizontal Example.png

Note that horizontal images are supported in 1.13+

Installation
  1. Download images-2.x.x.jar and place it in your plugins folder.
  2. Start your server to load the plugin and then stop the server.
  3. Open the config.yml found in the Images folder and configure the desired database (see spoiler for more information).
  4. Place any images in the Images folder.
  5. Start your server and start placing your images.
Three types of database are supported:
  • SQLite (Default)
    • If you don't have a dedicated database or don't know how to configure databases, this is the option for you. This is the default so just leave it as is.
  • MySQL
    • If you already have a MySQL database and wish to have CustomImages use that, then this can be set by setting the type to MYSQL in the config and add the login credential for your MySQL server.
    • (Advanced Users) If access to table creation permissions for the Custom Images MySQL user is an issue, set the database.initialize setting to false in the config and contact me for table information if needed.
  • Raw data file
    • This is a simple completely raw byte file that is written to. It is much slower than the other two options, but is slightly more space efficient since it does not have the overhead of table structures etc. This is not applicable to almost anyone, but if you are really tight on drive space you can use this format.

Commands
  • /image create <image name|url> [scale percent] - Create and begin pasting a new custom image
  • /image delete - Delete an existing image by clicking on it
  • /image delete near <range> - Delete images within a range
  • /image list - Show a list of the options of images that can be added
  • /image import - Import legacy images to the new format
  • /image transfer - Transfer images to a new database

Tabbing is supported so you can easily see all your file options by typing /image create and then tab.

You can scale an image while creating it by adding a percentage after the image name.
Code (Text):
/image create myImage.png 200
the above command would create an image scaled to 200% of the original image size. Any percentage is acceptable as long as it is greater than 0.

Scaling Example.png

Permissions
  • images.command.create
  • images.command.delete
  • images.command.delete.near
  • images.command.list
  • images.command.import
  • images.command.transfer

Troubleshooting
  • If you are having issues deleting images:
    • Right click the image in multiple places and in the center of blocks
    • Ensure you are on the same version of Minecraft on your client as your server (i.e. Spigot 1.14.4 try using 1.14.4 for your client too if not already).
    • Install ProtocolLib (this may or may not improve things)
    • Use the /delete near <range> command
  • If there is an error in console that contains the line below, this means you have deleted a world without first removing all the images. Recreate the world and delete all of the images (I recommend using the /delete near <range> command) before removing it
    Code (Text):
    java.lang.IllegalStateException: unknown world with ID deletedWorldName
  • If there is an error in console that contains and of the lines below, you most likely have an issue with your version of Java; update to at least Java 8 and either Oracle or OpenJDK. Java 11 can also have issues; I would recommend trying a JDK version if no other solution works.
    Code (Text):
    java.awt.AWTError: Assistive Technology not found: org.GNOME.Accessibility.AtkWrapper
    Code (Text):
    java.lang.NoClassDefFoundError: Could not initialize class sun.awt.X11.XToolkit
  • Please ensure that you are always on the most up-to-date minor version of each major version of Spigot or Paper. For example, if you are running 1.13 you should be running 1.13.2; for 1.8 it should be 1.8.8
  • I will attempt to give more tips here as more things become relevant
Report an Issue

Note: Please do not write a review in order to get help or report a bug. I will not help in this way. Write a discussion post or message me directly and I will help as quickly as possible.
  1. Make sure to read this entire post thoroughly especially the above troubleshooting and commands section before deciding that you have an issue and it is not user error.
  2. If you do have a bug, check the server console for errors after running a command that is having an issue or on server startup. An error may be many lines and is usually indented and/or red. This is very helpful in fixing issues.
  3. Write a discussion post or message me directly clearly describing your issue and giving relevant screenshots and any errors that you found.
  4. I will help as soon as I have time; I promise I'm not ignoring anything on purpose.

If you wish to donate to support development, you may use the link below to do so. Anything is appreciated :)

[​IMG]
Resource Information
Author:
----------
Total Downloads: 358,874
First Release: Feb 9, 2018
Last Update: Dec 6, 2024
Category: ---------------
All-Time Rating:
21 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings