Skip to content

Configuration

Jump to bottom
Ajaxan edited this page Dec 9, 2017 · 5 revisions

Hints

Hints allow players to more easily "discover" materials. It's quite likely that you've decided to simply tell people how to make alloys and there is nothing wrong with that. However, a huge factor of the fun of this plugin can be the process of slowly discovering materials. This is done through "hint" ingots. These are ingots, that as you get certain parts of the recipe correct, will have custom colors and names that gives players a clue that they may be close to discovering a recipe.

An example would be if a player got the smelting time correct, and also the materials. However, they failed to get the proper amounts of the materials. (Imagine they added 1 iron and 1 gold when the recipe called for 2 iron and 3 gold.) When they go to cool an ingot, instead of getting the normal result of missing a recipe they'll get a "partial ingot" which acts just like the failed recipe result but has a custom name hinting that they go something right. In our example, the correct Smelting time and Materials would result in an "Imperfect Ingot."

EnableHints: true

HintWords:

  • CorrectTimeAndMaterials: "Imperfect"
  • CorrectMaterialsAndAmounts: "Brittle"
  • CorrectMaterial: "Ruined"

Language

This section allows you to change the phrases that a player will receive upon performing certain actions. Unlike some plugins I don't provide language files, instead, I let you configure it to your liking! Also, as I add more updates and more phrases to the plugin, make sure to keep an eye out for them in the updates section. I'll make sure to post any new phrases that need to be added to the updates page.

phrases/Phrases:

  • FillCauldron: "Fill up the Cauldron first to use it to cool metal."
  • FailedRecipe: "The mixture turns to dust in the cauldron."
  • SuccessfulRecipe: "The metal hardens and cools."
  • ClickSmeltingForge: "This forge is currently smelting."
  • ForgeMaterialsFlushed: "The Forge ingredients have been flushed out."
  • RetrieveMoltenMetal: "You scoop the molten metal out of the forge."
  • ForgeSmeltingTime: "This forge has been smelting for "
  • ForgeJustBegunSmelting: "This forge has just begun smelting."
  • BreakForge: "You dismantle the forge."

Special Materials

This plugin includes some special new items that are made as a result of forging recipes incorrectly. These items allow for more forging possibilities and more interesting recipes. It is possible that they will be removed in the future though. Although untested, I am nearly certain, becuase of the plugins flexibility, these types of custom materials could be made as recipes in the config and then be used in other recipes.

For now, however, these special items are: TIN, COPPER, TINCOPPER, SCRAP_METAL, SCRAP_GOLD, CRYSTAL

They can be used as ingredients like any normal Minecraft item.

RECIPE MATERIALS

Smeltery only allows items listed below, on the left-hand side, to be put into a forge. Even if it appears in a recipe, if it does not appear in the list below, the player will be prevented from putting the item in the forge.

The right-hand side of the list determines what the outcomes of failed recipes. So when a player makes a recipe that includes mostly IRON_INGOTs but doesn't match and recipe the outcome of cooling the molten metal is a piece of SCRAP_METAL which is simple a custom named iron nugget.

Note, that if hints are enabled, the partial ingot will come out instead of the outcomes listed below if they ingredients were close enough to the correct recipe.

All materials can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html

materials/Materials:

  • IRON_INGOT: SCRAP_METAL
  • COAL: NONE
  • GRAVEL: TINCOPPER
  • GOLD_INGOT: SCRAP_GOLD
  • DIAMOND: CRYSTAL
  • EMERALD: CRYSTAL
  • OBSIDIAN: OBSIDIAN
  • STONE: COBBLESTONE
  • SULPHUR: EXPLODE
  • GLOWSTONE_DUST: NONE
  • REDSTONE: NONE
  • BLAZE_POWDER: EXPLODE
  • QUARTZ: COBBLESTONE
  • NETHER_BRICK: NETHER_BRICK
  • DRAGONS_BREATH: NONE

ALLOY OPTIONS

For each specific recipe, the following configurations can be set for both tools and armor. Make sure to pay special attention to some of the requirements for many Attribute options. They aren't super straight forward, but you can blame Jeb for that not me. I merely adopted attributes, they were created by Mojang.

name/Name: This is the name that will appear on the ingots, armor, and weapons.

tag/Tag: Each item must have a unique tag. Their names can be the same but every item's tag must be different. It'll never be seen by anyone but this is used by the plugin to differentiate between items.

baseitem/BaseItem: The base item determines three main things. The resulting ingot, the resulting partial ingot, and the resulting final armor look and base stats. There are only three possible bases at the moment as well: IRON_INGOT, GOLD_INGOT, and DIAMOND. So for example, a GOLD_INGOT based armor will have scrap gold partial ingots, gold looking ingots, and gold looking armor. The names and attributes may be different but the armor will look like gold. All materials can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html

smelttime/SmeltTime: This option determines the window of time in which players can smelt the recipe correctly. The window starts after a number of minutes determined by the smelttime variable and lasts for smelttime/2 minutes afterward rounded down. If this is a bit confusing, hopefully, this example helps. If you set smelttime to 6, the window of time to properly smelt the recipe is after 6 minutes but before 9 minutes have passed. Remember, time can be monitored with a clock! Just right click the forge.

Permission(1.4 only): This option attaches a specific permission to the recipe. Only players with the permission can craft the material. If there is no permission set, then the recipe will be craftable by everyone.

Fail Chance (1.4 only!): This option adds a 0% - 100% chance for the recipe to fail upon creation and turn to dust.

ingredients/Ingredients: This lists the items necessary to create this recipe. The Material and amount are separated by a "/".

  • IRON_INGOT/3 - This means the player must add 3 IRON_INGOTS to the forge
  • COAL/2 - Along with the 3 IRON_INGOTS, the player must also add 2 COAL.
  • DRAGONS_BREATH/1 - Finally, 1 DRAGONS_BREATH must be added.

attributes/ToolAbilities-ArmorAbilities: The attributes of tools and weapons are combined in version 1.3 of the config and separated in all following versions. So for tool attributes set the attributes under the ToolAttributes section and for armor use the ArmorAttributes section.

  • durabilitymultiplier/DurabilityMultiplier: This option allows you to change the durability of an item. Base durability given by the baseitem is 1.0. Which means that if you have a new recipe with IRON_INGOT baseitem and durability 1.0, the resulting armor and tools will have the same durability as their iron counterparts. If you increase the durability to 2.0 however, it'll double the durability of the item. If you set it to 0.5, it'll half the durability of the resultant items. NOTE: This does not change the vanilla durability. Instead, it'll take away more or less durability depending on the multiplier. An item with half durability will simply take double durability damage.
  • magicresistance/MagicResistance: Reduces the potency of all magic effect applied to the wearer/user. Or, if set negative, it'll increase the potency of all magic applied to the wearer/user.
  • Dodge(1.4 only): This Attribute accepts values from 0% - 100%. Adds that percent to dodge a melee attack while wearing the armor or using the tool/weapon.
  • Deflect(1.4 only): This Attribute accepts values from 0% - 100%. Adds that percent to dodge a ranged attack while wearing the armor or using the tool/weapon.
  • maxhealth/MaxHealth: This Attribute accepts only Integer values from -10 to +10. Each point represents half a heart.
  • attackdamage/AttackDamage: This Attribute accepts any numbers from -10.0 to +10.0. Each point represents one base damage.
  • movementspeed/MovementSpeed: This Attribute accepts any values from -0.1 to +10.0. Base speed is 0.1 for all players. A value of 0.01 for this Attribute increases speed by 10%.
  • knockbackresistance/KnockbackResistance: This attribute accepts any values from 0.0 to 1.0. Base player knockback resistance is 0. a value of 0.5 increase chance to resist knockback by 50%.
  • armor/Armor: This attribute accepts only Integer values from -100 to +100. Each point represents 1 base armor.
  • armortoughness/ArmorToughness: This Attribute accepts only Integer values from -100 to +100. Each point increases toughness by 1.
  • attackspeed/AttackSpeed: This attribute accepts any value from -4.0 to + 10.0. Base player attack speed is 4.0. All weapons and tools actually decrease attack speed. For example, a basic iron sword would have a value of -2.4 resulting in an attack speed of 1.6. (4.0 - 2.4 = 1.6)

slots/Items: Here you can configure the different types of items each recipe can be made into. It is very likely that in the future this section will be replaced with a better system. All values here accept trueor false.

  • helmet: This slot enables the ingots to be made into helmets.
  • chestplate/Chestplate: This slot enables the alloy to be made into chestplates.
  • leggings/Leggings: This slot enables the alloy to be made into leggings.
  • boots/Boots: This slot enables the alloy to be made into boots.
  • mainhand: (Config 1.3) This slot enables the alloy to be made into weapons and tools.
  • offhand: (Config 1.3) This slot enables the alloy to be made into shields. Only applies to IRON_INGOT base items.
  • Sword: This slot enables the alloy to be made into swords.
  • Axe: This slot enables the alloy to be made into axes.
  • Pickaxe: This slot enables the alloy to be made into pickaxes.
  • Shovel: This slot enables the alloy to be made into shovels.
  • Hoe: This slot enables the alloy to be made into hoes.
Clone this wiki locally