Skip to content

Getting Started

Mosaikin is a Minecraft server plugin that turns any image or animation into an in-world display made entirely of player head textures. No resource pack is needed — every vanilla client sees the wall automatically.

Walls are created by submitting texture images to MineSkin, which generates the player head skins that make up each wall. For large or animated walls this process can take a significant amount of time, so read the MineSkin section below before you begin.

Requirements

  • Paper 1.20.1 or newer (Spigot is not supported)
  • A MineSkin API key — free to obtain, paid subscription strongly recommended
  • Operator (/op) or appropriate permissions on your server

Installing the Plugin

modrinth

Drop the plugin .jar into your server's plugins/ folder and restart the server. A default config.yml will be generated in plugins/Mosaikin/.

Setting Up Your MineSkin API Key

Mosaikin uses MineSkin to generate the player head textures that make up each wall. An API key is required.

  1. Create a MineSkin account and get an API key from account.mineskin.org.
  2. Set the key using one of the two methods below.

Option A — Edit config.yml:

yaml
mineskin:
  apiKey: "your-api-key-here"

Then run /mosaikin reload in-game to apply the change without restarting the server.

Option B — Set at runtime:

/mosaikin apikey your-api-key-here
/mosaikin reload

This saves the key to config.yml and reloads the config.

MineSkin Subscription

A paid MineSkin subscription is strongly recommended

Mosaikin relies heavily on MineSkin for skin generation. On the free tier, generation is limited to a single concurrent skin and will be significantly slower.

  • Still images with only a small number of unique regions may be workable on the free tier, but expect to wait.
  • Animations generate far more skins and will take hours on the free tier — a paid subscription is essentially required for any practical use with animations.

Walls with more than 2,000 unique player heads can take up to an hour or more to generate even on a paid plan, depending on your subscription tier. Smaller, simpler images generate much faster.

View MineSkin subscription options →

Note: both Mosaikin and MineSkin are operated by inventivetalent.

Next Steps

With the plugin installed and your API key configured, you're ready to create your first wall.