RP Engine 0.2.2

Spigot and Paper 1.19.4 and newer · Java 17+ · Free and open source (GPL-3.0) · No client mods

Documentation · Discord · Source code · Addons

What is RP Engine?

RP Engine turns a folder of YAML on your own server into custom items, blocks, furniture, animated models, player emotes, vehicles, screens, HUDs, dialogs, sounds and recipes. Then it builds the resource pack and hands it to every player who joins.

You write the content. The engine writes the pack.

# plugins/RPEngine/content/mypack/items/gems.yml
ruby:
  material: DIAMOND
  name: "Ruby"

Drop ruby.png next to it, run /rp reload, then /rp give mypack:ruby. The model, the texture, the pack and the item component that ties them together are all worked out for you.

Features

• ✔ Custom items: names, lore, enchantments, attributes, durability, food, and actions when they are used.
• ✔ Custom blocks: hardness, the right tool, light and drops, plus stairs, slabs, doors, trapdoors, plants and lamps.
• ✔ Furniture: place any Blockbench model. The hitbox is measured from the model, and pieces can be seats, lights or storage.
• ✔ Animated models: drop in a .bbmodel and its bones and animations play as you made them. Place it in the world, or put it on a mob, including MythicMobs mobs and Citizens NPCs.
• ✔ Player emotes: /emote wave, on your own or with a cast of friends who are asked first. Movement sets replace how a player walks.
• ✔ Vehicles you drive: cars, bikes, boats, aeroplanes and helicopters, with real handling, passenger seats, sounds, particles and an animation for each state.
• ✔ Custom mobs: your own entities with your own models.
• ✔ Armour: any item can be worn with its own art.
• ✔ GUI screens and HUD overlays: your own menu backgrounds and on-screen art.
• ✔ Dialogs (1.21.6+): menus drawn your way, with sidebars and pages, switches, sliders and dropdowns that open, players' heads, progress bars, live placeholders and item slots. Every click makes the game's button sound.
• ✔ Sounds and chat icons: type :mypack:heart: in chat and the picture appears.
• ✔ Recipes: crafting, cooking, campfire, stonecutter, smithing and trims, anvil, and brewing on Paper.
• ✔ Liquids: mark out a pool of acid, slime or anything else. It is real water or lava with your rules applied to whoever is in it.
• ✔ The pack is built and hosted for you, with the right pack format for your server's version. Or switch the host off and serve the zip from your own web server.

The comparison as a PDF, with notes and where each column was checked

Edit in your browser

/rp edit mypack:chair gives you a link. It opens the model in a proper 3D editor in your browser: move the cubes, repaint it, then press Send to server. The file in your content folder changes and reloads. No account and no sign-in. The link works once and lasts three hours, and it carries only the one thing you named.

Moving from another plugin?

RP Engine reads ItemsAdder, Nexo, Oraxen, CraftEngine, Model Engine and BetterModel content folders as they are. Put the folder in, reload, and your items, furniture, blocks, models and recipes come across. Anything that cannot come across is named in a warning at load, with the reason, so nothing goes missing silently.

The full compatibility sheet, as a PDF

Works with

All optional. RP Engine runs fine without any of them.

• PlaceholderAPI: RP Engine's own placeholders for scoreboards, menus and holograms, and any plugin's placeholders in HUD text and item actions.
• MythicMobs and Citizens: put animated models on their mobs and NPCs.
• WorldGuard: region flags for where models can be placed and custom items used.

Installing

1. Drop RPEngine.jar into plugins/ and start the server.
2. In plugins/RPEngine/config.yml, set host.public-address to an address your players can reach, and open that port (8181 by default). This is how players download the pack.
3. Add a content folder under plugins/RPEngine/content/ and run /rp reload.

Full guide: resourcepack.ai/docs/rp-engine/install

Requirements: Spigot, Paper or a fork of either, Minecraft 1.19.4 or newer, Java 17 or newer. Everything from 1.19.4 to the current version works. On an older server, the few features that need a newer game are switched off, and the startup log names each one.

Commands and permissions

Every subcommand has its own permission, rpengine.<subcommand>. rpengine.admin (default: op) grants all of them. /rp, /rpe and /rpengine are the same command.

Every command and permission: resourcepack.ai/docs/rp-engine/commands

Addons

Plugins built on RP Engine's public API, each a second jar you drop in beside it. The first is Skateboards: push, tuck, jump, flick it round, and try not to bail.

For developers: RP Engine has a full API for items, models, vehicles, emotes, screens and events. See API.md.

What it connects to

• Usage count. Every 30 seconds the plugin sends resourcepack.ai a random id that it made up the first time it started, how many players are online (a single number), and the names of any installed plugins that depend on RP Engine (its addons), so we know how many servers and players use it and which addons. It is anonymous: no address, server name, version, player names or UUIDs, or content. It is on by default. Turn it off with telemetry.enabled: false in config.yml.
• Update check. A few seconds after start and every six hours after, the plugin asks SpigotMC which version of RP Engine is current, and tells the console and ops if there is a newer one. It sends nothing about your server. Turn it off with update-check: false.
• Browser editing only connects when you run /rp edit, and only sends the one file you named. Turn it off with edit.enabled: false.
• Studio pushes and published packs only connect after you pair with /rp sync or /rp distribute.

With all of that off, the plugin talks to nothing but your own players.

Support

Ask on Discord or open an issue on GitHub. Please don't post bugs in the reviews; we can't reply there, and we would rather fix it.

RP Engine is free software under the GPL-3.0 licence. The source is on GitHub, and contributions are welcome.

Made by ResourcePack AI

RP Engine comes from resourcepack.ai, a web editor for resource packs that can generate models, textures, GUIs, emotes and vehicles and push them straight to your server for live testing. You never need it: a hand-written content folder gets the whole plugin.