Locked Crafting

A paper plugin

---

If you use this plugin in your paper server, you can make some crafting recipes only work if you have set required items in your inventory.

By default, after trying to craft a locked recipe, it will tell you what items you are missing, and what required items you have. You can stop it from telling you either or both of these.

---

Some Uses:

One use for this plugin is to control the flow of powerful items, such as the mace. You would choose an item there is only one of on the server (either the dragon egg or a creative-only item you give to someone), and lock the use to that. That would be a way to give these rare but useless items a use, and keep players' power in check. If there is an economy plugin and some form of trade (such as an auction house), both the locked item and the key could sell for lots of money.

You could also use this plugin to lock items behind hard-to-get items, such as a spear behind a netherite block, without requiring you to do all that again if you lose it or it breaks.

---

How To Configure Messages

To configure this plugin, go to your server directory, then go to:
/plugins/LockedCrafting/config.yml

In the config.yml file, there is a section called messages. You can configure these.

Missing Requirements (messages.missingReqs)

When a player tries to craft an item but is blocked by this plugin, the player will be sent a message in chat telling them why. You can configure this message however you want, under messages.missingReqs
The message goes like this:

1. It sends the message in pre
2. If sayMissing is set to true, it tells the player what items they are missing, with each item separated by a new line
3. It sends the message in between
4. If sayThere is set to true, it tells the player what required items they have, with each item separated by a new line.

---

How to Configure Locked Recipes

To configure this plugin, go to your server directory, then go to:
/plugins/LockedCrafting/config.yml

In the config.yml file, there is a section called recipes. This is how you change recipe requirements.

Recipes

Each recipe takes two layers of YAML code. The first layer is the namespace of the recipe. In most cases, this namespace is minecraft, so if this is the case you can omit the namespace and just use the recipe name (as shown in the diamond_spear recipe in the default).

How to find recipe names

When you put a recipe in the crafting grid, the logger will say:
Crafting recipe namespace:key
You can use this to find the name of a recipe

If the namespace isn't minecraft, the outer layer is the namespace and the inner layer is the key, also known as the name. You can do this if the namespace is minecraft, as well, as shown by the mace recipe in the default.

Requirements

Under a recipe, there is a list called itemReqs. Each element in the array corresponds to an item you need to have in order to craft this recipe. Lists can be formatted in square brackets, like the diamond_spear example, or with dashes, like the mace example.