Get started

Installing

RP Engine is one jar. You put it in plugins/, start the server, and players are sent its resource pack when they join. There is nothing else to set up.

What your server needs#

• Spigot, Paper or Folia, on Minecraft 1.19.4 or newer. Folia uses the same jar.
• Java 17 or newer.

Everything works on a current server. Older versions lose a few features (one pack at a time below 1.20.3, no dialogs below 1.21.6, and so on), and the plugin prints exactly which ones at startup. Minecraft versions has the full list.

Putting it on your server#

1. 1

   Get the jar

   Download RPEngine.jarhttps://cdn.resourcepack.ai/RPEngine.jar

   That link always points at the current release, so it works in a startup script or a Docker build too.

2. 2

   Drop it in

   Put RPEngine.jar in your server's plugins/ folder and start the server.

3. 3

   Look at what it made

   plugins/RPEngine/
     config.yml
     content/      ← your packs go here
     output/       ← the built packs, rebuilt on every reload

4. 4

   Join

   You are asked to accept the server's resource pack. That is RP Engine's.

   By default the pack is uploaded to ResourcePack AI's free pack host and players download it from there, so no port has to be opened and it works behind Velocity or BungeeCord. To serve it from your own machine instead, see Serving the pack.

You do not set a pack format number. The plugin reads your server's version and writes the right one itself.

Your first item#

1. 1

   Make a pack

   A pack is a folder in content/. Its name, here mypack, becomes the first half of every ID in it.

   content/mypack/
     pack.yml
     items/gems.yml
     assets/textures/item/ruby.png

   pack.yml can be as short as a name:

   name: My Pack

2. 2

   Describe the item

   items/gems.yml:

   ruby:
     material: DIAMOND
     name: "&cRuby"

   That is mypack:ruby: the folder name, then the key. Its texture is found from the ID, at assets/textures/item/ruby.png, with nothing pointing at it.

3. 3

   Reload and take one

   /rp reload
   /rp give mypack:ruby

   Everybody online is sent the new pack.

If the item shows as a purple-and-black square, the texture is not where the ID says it should be. /rp reload names every missing file in the console; the content folder explains each warning.

Already have a pack?#

An exported Studio pack or any other resource pack .zip goes straight into content/: drop it in and run /rp reload. See Adding a resource pack.

Where to go next#