Feruchemy Plugin

Feruchemy Plugin

Mistborn-style metalminds for Paper servers. By KidK, creator of the True Feruchemy mod.

What is this?

Feruchemy brings the magic of Mistborn to your server. You wear metalminds (bracers and rings) and store an attribute such as your speed, weight, health or even your XP. Later you tap the metalmind to get it back. Storing gives you a drawback, tapping gives you a boost, and every metal has its own pair.

• 16 metals, plus the one-of-a-kind Bands of Mourning
• Craftable bracers and rings, with alloy recipes to upgrade your metals
• Metalminds key to the first player who uses them, and can be unkeyed or wiped
• A wandering Terris Merchant who sells (and buys back) metalminds for emeralds
• Custom item models through a matching resource pack
• Nearly everything is configurable

Getting started

1. Get a metalmind. New players receive a free ring of a random metal (iron, steel, tin, pewter or gold) the first time they join.
2. Right-click it to start storing. Right-click again to tap what you have stored, and once more to switch it off. Tapping only works once something is stored.
3. A switched-on metalmind works from anywhere in your inventory, but not while it sits in a chest or on the ground.
4. Prefer commands? /metal <metal> <store|tap|off> switches every metalmind of that metal in your inventory.
5. Active metalminds show on your action bar, and each tooltip shows what it stores, its mode, how full it is and who it is keyed to.

Good to know:

• Bracers hold 1000 and rings hold 500 by default. Storing adds 5 per second and tapping uses 10 per second. A full metalmind stops giving its store effect, and an empty one switches itself off.
• You can carry several at once. If one metalmind of a metal is storing while another of the same metal is tapping, their effects cancel out.
• Right-clicking doors, chests, crafting tables and similar blocks opens them as normal. Sneak while right-clicking to use the metalmind instead.
• Metalminds are made of paper (copper is a writable book), so they cannot be used up in normal recipes such as books, maps or fireworks.

The metals

Metal	Stores	While storing	While tapping
Iron	Weight	Light and floaty, with soft landings	Heavy, with knockback resistance
Steel	Speed	Slowness and mining fatigue	Speed and haste
Tin	Senses	Blindness	Night vision
Pewter	Strength	Weakness and mining fatigue	Strength, resistance, haste and extra hearts
Zinc	Mental Power	Slowness, weakness, mining fatigue and hunger	Repairs the item in your main hand, and gives level 30 enchanting anywhere
Brass	Warmth	Freezing cold	Warmth, removes freezing
Copper	Memories	A writable notepad (never sign it)	A writable notepad
Bronze	Wakefulness	Slowness, fatigue and weakness	Sleeps through the night like a bed, without changing your spawn
Cadmium	Breath	Suffocating	Full air
Bendalloy	Hunger	Very hungry and nauseous	Full hunger and saturation
Gold	Health	Poison and fewer hearts	An instant heal of about half your health, then strong regeneration
Electrum	Determination	Slowness, fatigue and weakness	Speed, haste, strength and jump boost
Chromium	Luck	Bad luck	Good luck
Nicrosil	XP	Stores your experience levels, faster the longer you keep going	Gives the XP back, also faster over time
Aluminum	Identity	Invisibility	Glowing
Duralumin	Connection	Bad omen effects	Hero of the Village
Bands of Mourning	Everything	Every store effect at once, stronger	Every tap effect at once, stronger

These are the default effects. Capacities, rates and several effect strengths can be changed in the config. Nicrosil metalminds hold 50% more than other metalminds of the same kind.

Crafting and alloys

Iron, gold and copper can be crafted from nuggets and ingots:

• Bracer: nugget, ingot, nugget on the top row, then nugget, empty, nugget on the bottom row
• Ring: eight nuggets in a ring

Alloys are made by combining blank metalminds of the same kind (bracer with bracer, ring with ring) with one extra item. The recipes are shapeless:

Result	Ingredients
Steel	Iron + coal
Electrum	Gold + nether quartz
Brass	Copper + zinc
Bronze	Copper + tin
Pewter	Tin + netherite scrap
Bendalloy	Cadmium + netherite scrap
Nicrosil	Chromium + iron ingot
Duralumin	Aluminum + copper

The extra items stand in for metals Minecraft does not have, and you can change them in the config. Tin, zinc, cadmium, chromium and aluminum cannot be crafted from raw materials, so look for the merchant (or ask an admin).

Only blank metalminds work in alloy recipes: ones that have never been used, or have been wiped.

The wandering Terris Merchant

Every 30 to 60 minutes (configurable) a merchant appears near a random online player in the Overworld, stays for 10 minutes, then packs up and leaves. Players nearby are told when he arrives.

• 9 trades per visit: 5 common metalminds, 2 rare ones and 2 buy-backs that pay you in emeralds
• Bracers cost 24 emeralds (common) or 56 emeralds (rare) by default, and rings cost half
• Each trade can be used twice per visit
• He only buys blank metalminds
• /metalmerchant status tells anyone when the next visit is

Keying, unkeying and wiping

• A blank metalmind says Not yet a metalmind. The first player to use it becomes its owner, and its tooltip shows who it is keyed to. Nobody else can use it.
• /metalmind unkey while holding one lets you set it free for good. Anyone can use it from then on, and it never keys again, so it can be passed around or traded.
• /metalmind wipe lets the owner erase their identity and everything stored in it, turning it blank again. Blank metalminds can be sold to the merchant and used in alloy recipes.

The Bands of Mourning

The rarest artifact in the plugin. It holds every power at once, only one can ever exist, and it is never keyed to anyone.

• Gives all the metals' effects at a stronger level, with a huge capacity. It starts over half full, which makes it the only metalmind that is not empty by default.
• Held in your hand it works as a weapon, and it hits hard.
• Super jump: it only happens on demand. With the Bands tapped, press the swap-hands key (F by default) for a big leap with a soft landing. You can switch this to a double press of Space in the config, and tune the power, duration and cooldown.
• Only one: a second copy crumbles to dust when someone picks it up. Admins can create the Bands with /metalmind give bands_of_mourning, and it refuses if they already exist.
• No hiding: the Bands cannot be kept in an ender chest, and they never despawn or burn on the ground.
• Compass: if the Bands are left behind for a minute (in a chest, barrel, shelf, item frame or on the ground), every online player gets a compass pointing to them. The compasses disappear when someone picks the Bands up again. The compass only works in the same dimension as the Bands. You can also have the coordinates posted in chat at an interval.
• Admins can use /metalmind bands status to see where they are and /metalmind bands reset to forget them if they were destroyed.

Installation

1. This plugin needs Paper 26.3. Spigot, Bukkit and Folia are not supported.
2. Put the plugin jar in your plugins folder and start the server. The config is created at plugins/Feruchemy-Plugin-V2/config.yml.
3. Install the resource pack (see below), then edit the config if you like. Use /metalmind reload to apply changes. Alloy recipe items are only read at startup, so restart the server after changing them.

The resource pack

The plugin works without the resource pack, but the metalminds will look like plain paper and books. The pack gives every metal its own bracer and ring model, plus the Bands of Mourning.

To send it to your players automatically, put the direct download link (ending in .zip) in quotes in the config under resource-pack: url. You can also set the pack's sha1 and the page-url of its download page. Players who decline the pack or whose download fails get a link, and anyone can request it again with /metalmind pack.

Download the resource pack here: (add the resource pack link)

Commands

• /metal <metal> <store|tap|off>: switch the metalminds of a metal in your inventory
• /metalmind unkey: free the metalmind in your hand so anyone can use it
• /metalmind wipe: erase your identity from the metalmind in your hand
• /metalmind pack: send yourself the resource pack again
• /metalmind give <metal> [bracer|ring] [player]: give a metalmind (operators)
• /metalmind reload: reload the config (operators)
• /metalmind bands <status|reset>: check on or forget the Bands of Mourning (operators)
• /metalfill [metal|all]: instantly fill metalminds (operators)
• /metalmerchant status: when the merchant is here or next arrives (everyone)
• /metalmerchant <spawn|remove>: call or dismiss the merchant (operators)

Permissions

All three default to operators.

• feruchemy.give: /metalmind give, /metalmind reload, /metalmind bands, and unkeying or wiping other players' metalminds
• feruchemy.fill: /metalfill
• feruchemy.merchant: /metalmerchant spawn and remove

Configuration

The config is commented and covers:

• rates and capacity: store and tap speeds, bracer, ring and Bands sizes, the night-skip cost
• metal tuning: the gold heal, iron gravity, nicrosil ramp-up
• bands: attack damage, potion boost, super jump key, power, duration and cooldown, the one-only rule, and the compass delay, scan rate and chat broadcast
• starter: whether new players get a ring, and which metals it can be
• alloys: the stand-in items for silver, lead, nickel and carbon
• merchant: visit timing, stay time, trade prices, which metals appear, the skin the merchant wears
• messages: optional messages when tapping begins or the gold heal recharges
• resource-pack: the link, checksum and prompt

FAQ

Do I need the resource pack? No, but it is recommended. Without it, the items show as purple and black missing texture squares.

Why will my old metalmind not craft into an alloy? Alloys only accept blank metalminds. Wipe it first with /metalmind wipe, or use a fresh one.

Why can I not open a chest while holding my bracer? You can: right-click normally to open it, and sneak while right-clicking to use the metalmind instead.

Can the Bands of Mourning be crafted or bought? No. An admin has to create them, and only one can exist.

Credits

Inspired by Feruchemy from the Mistborn series by Brandon Sanderson. This is an unofficial fan project and is not affiliated with or endorsed by Brandon Sanderson or Dragonsteel. The item models and textures come from the True Feruchemy mod by KidK.