The main command is /imageframe (aliases: /iframe, /if, /frame). All creation commands are op-only by default. Sizes are measured in maps — one map fills one item frame block, so a 4 x 3 image needs a 4-wide by 3-tall grid of item frames.

Quick way — create straight onto a wall

Place a grid of item frames on the wall (e.g. 4 wide × 3 tall).
Run /imageframe select, then left-click one corner frame and right-click the opposite corner frame to select the whole grid.
Run /imageframe create <name> <url> selection.

The image is downloaded, sized to your selection, and placed into the frames automatically.

Manual way — create, then place yourself

/imageframe create <name> <url> <width> <height> — creates the image map (width/height in maps).
Put it on frames one of two ways:
- /imageframe get <name> — gives you the map item(s); place each on the item frames in order (left→right, top→bottom).
- or select a frame grid (as above) and run /imageframe get <name> selection to auto-fill it.

Using bundled maps

Bundled maps are canonical maps shipped inside the plugin jar: maps.yml defines each map (name, size, dithering, and pinned Minecraft map ids) and the images live under maps/ in the jar. They are re-rendered from the jar on every startup and never touch the plugin data folder, so they survive data wipes — the pinned map ids keep existing item frames in the world pointing at the right maps, the same way LaunchPads-OG preserves pad locations in its config.

Bundled maps are owned by Console. Anyone with access can see them with /imageframe list and use them by name:

/imageframe get <name> selection, or reference them explicitly as Console:<name>.

To add or change a bundled map, edit common/src/main/resources/maps.yml and the images in common/src/main/resources/maps/, then rebuild the jar. Never change the MapIds of an existing map — item frames in the world reference those ids.

Useful extras

/imageframe info <name> — shows a map's size (handy to build a matching frame grid) and its URL.
/imageframe refresh <name> — re-downloads and re-renders an existing map.
Optional flags on create/get: a dithering type, and combined/separated.

Behaviour of this fork

Images are stretched to fill the whole frame grid (edge to edge) instead of being letterboxed with a transparent border. Match your frame grid's width:height to the image's aspect ratio to avoid distortion.
Item frames filled by the plugin are automatically made invisible, so neighbouring tiles join seamlessly with no thin border between them.

Built against Spigot

Built against Spigot's API (required mc versions are listed on the spigot page above). Plugins built against Spigot usually also work with Paper.

Development Builds

Jenkins

Maven

<repository>
  <id>loohp-repo</id>
  <url>https://repo.loohpjames.com/repository</url>
</repository>

<dependency>
  <groupId>com.loohp</groupId>
  <artifactId>ImageFrame</artifactId>
  <version>VERSION</version>
  <scope>provided</scope>
</dependency>

Replace VERSION with the version number.

Official Addons

ImageFrameClient (Complementary client mod for servers with ImageFrame to display HD and full color images)

Partnerships

Server Hosting

Use the link or click the banner below to get a 25% discount off your first month when buying any of their gaming servers!
It also supports my development, take it as an alternative way to donate while getting your very own Minecraft server as well!

P.S. Using the link or clicking the banner rather than the code supports me more! (Costs you no extra!)

https://www.bisecthosting.com/loohp

README.md Unescape Escape

ImageFrame

Creating Images In-Game