Migrating
Moving from Nexo or Oraxen
RP Engine reads Nexo and Oraxen config files as they are, so you can move your items, furniture, blocks, glyphs, sounds and recipes across without rewriting them.
- Make a folder in
plugins/RPEngine/content/for the pack, such asmy_pack/. Its name becomes the namespace, the first half of every ID (my_pack:ruby). - Copy
items/,glyphs/,recipes/andsounds.ymlout ofplugins/Nexo/orplugins/Oraxen/into it. - Copy the art:
- Nexo: copy
plugins/Nexo/pack/assets/tomy_pack/resourcepack/assets/, every namespace in it. Models and textures you bought usually sit inplugins/Nexo/pack/external_packs/instead, as zips or folders: unzip each one and merge itsassets/into the same place. - Oraxen: copy
pack/models/andpack/textures/tomy_pack/models/andmy_pack/textures/.
- Nexo: copy
- Start the server, or run
/rp reload, and read the console for warnings.
plugins/RPEngine/content/
my_pack/
items/ ← from Nexo/items/<your-pack>/ or Oraxen/items/<your-pack>/
glyphs/ ← from glyphs/
recipes/ ← from recipes/: Nexo's type folders or Oraxen's shaped.yml and friends
sounds/ ← sounds.yml
resourcepack/
assets/ ← Nexo/pack/assets/, plus each pack from external_packs/
minecraft/
<other namespaces>/A path with no namespace in a Nexo item or glyph (model: furniture/chair) means
assets/minecraft/, as it does in Nexo, and a namespaced one (shop:furniture/chair)
means that namespace's folder.
There is nothing to turn on and no pack.yml (RP Engine's own pack file) is
needed: each file is recognised by its shape. So one of their files also works
inside a pack of yours, which is handy for moving over a piece at a time.
Both plugins' current formats are read (Nexo 1.28, Oraxen 1.220), and Oraxen's
older capitalised sections too.
What comes across#
| Nexo / Oraxen | RP Engine |
|---|---|
| item id | an item under the content pack's namespace |
material, lore, unbreakable | the same |
itemname, displayname or customname | name |
Pack.model | model |
Pack.texture (Nexo), pack.textures (Oraxen) | texture, the first layer |
Components.item_model | model, for Nexo items with no Pack: |
Enchantments | enchantments |
AttributeModifiers, list or map form | attributes, with operation and slot |
durability, max_damage | durability |
max_stack_size | stack |
food | food |
enchantment_glint_override: true | glow |
custom armour: equippable, trim_pattern, or an id like ruby_helmet | armor, worn with the set's layer art |
Pack.CustomArmor layers, or ruby_armor_layer_1.png / _2.png anywhere in the pack | the layer art, found the way the plugins find it |
equippable on the head with no asset_id / model | hat, so a 3D helmet shows its model |
ItemFlags | flags |
Mechanics.commands | actions on either click (on eating, for food), with its cooldown, permission and one_usage |
Mechanics.custom | actions, for its CLICK, DROP, PICKUP and BREAK events |
furniture or block clickActions, Oraxen's events | the piece's own interact |
Oraxen's legacy food, consumable, consumable_potion_effects | food, and consume / right_click actions |
soulbound | keep-on-death |
Oraxen's hat | hat |
Mechanics.furniture | place: |
| furniture barriers | solid: true |
| furniture interaction hitbox | width and height |
| furniture seat | seat, all three numbers |
| furniture light | light |
restricted_rotation | facing: 8 ways by default, 4 for VERY_STRICT |
limited_placing | surface |
a uniform scale | scale |
a nexo_item / oraxen_item drop | drop |
furniture storage | storage: the same five kinds, rows, title and sounds |
furniture jukebox | jukebox, with its volume, pitch and permission; Oraxen's active_model is playing-model |
furniture door | a second state: turned a quarter (or only slid, for is_sliding) and moved by its open_properties translation, not solid when open if toggle_hitbox_on_open says so, with its open and close sounds, and automatic_close_delay as reset-after |
Nexo's furniture states | one state each, wearing its item model, light, barrier and translation, with reset_after |
a switched light: lights.toggleable, Oraxen's toggle_light | dark as placed (or Oraxen's base level), lit as a state, wearing toggled_model / toggled_item_model |
rotatable | states that each turn the piece one step further: a quarter on four facings, an eighth on eight |
evolution (next_stage, delay, probability) | grow: into, after, chance |
Nexo's connectable (straight, left, right, inner, outer, or a default they are named after) | connects, facing one of four ways |
custom_block (Nexo), block (Oraxen), the old noteblock | a custom block, with its model, hardness, tool, drop, light and place sound. Its shape is below |
a block drawn by a model the plugin generates from parent_model and textures | the same model, generated here and written inline |
Oraxen breaking rules | the first rule's hardness, tool and drop |
| static glyph | an icon, with its height and ascent |
glyph grid (rows, columns) | one icon per cell, <id>_1 onwards, numbered the way <glyph:id:N> numbers them |
reference glyph (reference, index) | an icon drawing that cell of the sheet it names, in the same file |
Oraxen animation: {frames, fps, loop} | an animated icon, the whole strip |
Nexo gif, frame_count | an animated icon drawn from the GIF, frame_count as its frames |
glyph placeholders, Oraxen chat.placeholders | the icon's chat aliases |
glyph permission, Oraxen chat.permission | the icon's permission |
sounds.yml entry | a sound, with its file, category, subtitle, volume, pitch and stream |
| shaped, shapeless, furnace, blasting, smoking, campfire and stonecutting recipes | recipes, with vanilla, Nexo and Oraxen ingredients |
smithing recipes, Nexo's trim_pattern and copy_components included | smithing and smithing_trim recipes |
| Nexo brewing recipes | brewing recipes, which need Paper |
anvil recipes: Oraxen's base, addition and experience_cost, Nexo's input, material, cost and repair | anvil recipes, a repair where there is no result |
An item model such as my_pack:item/ruby becomes RP Engine's item/ruby.
Nothing depends on the old plugin's CustomModelData numbers.
Blocks in their own shapes#
Both plugins make a custom block by borrowing an unused state of a vanilla
block, and the block's type says which. Each has an equivalent here:
Nexo / Oraxen type | RP Engine |
|---|---|
NOTEBLOCK / FULL | a note block, as an ordinary custom block |
STRINGBLOCK / STRING, the old stringblock | a plant, on cut tripwire |
CHORUSBLOCK / CHORUS, the old chorusblock | shape: grate, the see-through full block |
| a mushroom type | base: mushroom_stem |
Oraxen's STAIR, SLAB, DOOR, TRAPDOOR, GRATE, BULB | that shape:, made from the block's textures (a door's [bottom, top], a bulb's [off, on]), on the same waxed copper Oraxen used: custom_variation 1 to 4 is fresh, exposed, weathered, oxidized |
What a block does comes across where there is an equivalent:
| Nexo / Oraxen | RP Engine |
|---|---|
directional LOG · FURNACE · DROPPER / BARREL | rotate: axis · horizontal · all. Where the set names a block per direction (y_block, north_block, ...), each direction wears that block's model, and those blocks are not placed as blocks of their own |
storage | storage, the same kinds |
is_falling | falls |
blast_resistant | blast-resistant |
log_strip (stripped_log, drop) | strip |
light | light |
Click commands and other behaviour#
A click action's [console], [player], [message], [actionbar] and
[sound] (with its volume and pitch) become console, run, message,
actionbar and sound steps, and <player> and %p% become {player}.
Oraxen's newer events read the same way, executor: console or player. A
condition that only checks a permission (#player.hasPermission("x")) becomes a
permission step; any other condition is a branch, which actions do not have,
so what sits behind it is skipped and named. A commands cooldown comes across
in Nexo's units (5s, 10t) or Oraxen's milliseconds.
What does not#
Each of these is a warning naming the ID when the pack loads, so nothing is dropped silently.
Most of a world does not come across
Block and furniture definitions translate. Most of what is already placed in a world does not: the vanilla state a note-block or string block hides in was allocated by the plugin against its own numbering, and placed furniture is the plugin's own entities. Those have to be rebuilt or remapped by hand.
Oraxen's shapes are the exception. Its stairs, slabs, doors, trapdoors, grates and bulbs keep the very waxed copper Oraxen put them on, so the ones already standing in a world are still those blocks after the move.
The note-block pool here is also smaller, 49 per base, because the instrument cannot be part of a block's identity. A pack with hundreds of blocks will not fit as it stands.
Furniture behaviour with nothing to land on: beds (the game only lets a
player sleep in a bed block, and wakes anybody lying anywhere else), a
connectable that picks its look from one item model reading the connection
off the item (name the five looks and it joins), text floating over a piece, a modelengine_id (import the .bbmodel and give the item that
model instead), a farmland requirement, BlockLocker protection, a left-click
event on a placed piece (a left click breaks it here), opped_player
commands, armor_effects, backpacks and the rest of Mechanics. Each is
named with the reason. The item still loads.
One list of states per piece. A door, Nexo's states, a switched light and
rotatable all become the piece's states, and a piece has one list of them,
so where a piece has several the first in that order wins and the others say
so. Of a door, its open_properties rotation is not carried (an open hinged
door turns a quarter here) and nor is delay_hitbox_toggle. Of Nexo's states,
Model Engine and CustomModelData states, conditions and next_after are not
carried. Of evolution, light_boost, rain_boost and bone meal are
dropped: a piece here grows at one steady chance.
Block behaviour with nothing to land on: of a string block, sapling
(growing into a pasted schematic; grow: steps a
plant through its own stages instead), is_tall (only the lower block is the
plant), random_place, stackable, requires_supporting and
placeable_on_water; directional on anything but a full block; and
beacon_base_block, farmblock, limited_placing and placeable, each with
its reason.
More than one of something: extra seats, extra lights and extra hitboxes. The first (or the one at the anchor) comes across, and the warning counts the rest.
Some of a glyph: tab completion, a fixed char, a font of its own and
is_emoji, because an RP Engine icon goes into the default font and is given
its character by ID; a GIF's offset (use ascent); and placeholders on a
multi-bitmap glyph, which became several icons a placeholder cannot type all
of. Animated glyphs move where RP Engine's icons move, and are their first
frame in chat: see why.
Cauldron, grindstone, crafter, transmute and predicate recipes, and any
recipe with an ingredient that is a tag or another plugin's item. Those are
skipped whole and named, rather than loaded with an ingredient missing. A
recipe's permission is not carried across either: RP Engine recipes are open
to everyone.
Sounds that replace a vanilla one (minecraft: ids and replace: true):
put those in overrides/sounds.json instead.
Good to know#
Armour art stays where it is. Both plugins pair a set's art with its
pieces by name, ruby_armor_layer_1.png for the body and boots and _2.png for
the leggings of the ruby set, and RP Engine does the same: it finds those files
wherever they are in the pack and serves them on
vanilla's equipment path. Component, trim and the old
shader armour all use the same art, so all three come across. It is drawn from
Minecraft 1.21.4; on an older server the armour is still worn but with vanilla
art, and the build names every piece that will. An elytra's wings are not
carried, because RP Engine draws worn items on a player's body only.
Some art has to move. RP Engine reads icons from assets/textures/font/,
and Nexo and Oraxen keep them elsewhere. The load warns with the exact path.
Seats are worth a look in game. Oraxen measures a seat from where its
armour stand stands and RP Engine from where the rider sits, so Oraxen seats
are converted and the load says so. Nexo seats come across as written. Either
way, if a chair sits people slightly wrong, adjust its seat:.