A customizable custom crafting UI, which allows admins to change item ingredients or add new item

Supported Games
depends on

Craft UI is a complete recreation of the stock Facepunch crafting UI using CUI. It allows admins to set the ingredient requirements of an item, block an item from being viewed in the UI, set the crafting rate of an item, rename and item, or change the icon of an item.

But why? Why use this plugin instead of the stock Facepunch crafting UI? The Facepunch crafting UI exists only on the clients machine. This means that, even if you change the ingredient requirements of an item on the server, the client will still only be able to craft that item for it’s default cost. The client’s UI does not know that the item’s cost was changed. Creating an entirely new crafting UI allows full customization of item costs.

CraftUI is still in an early development stage. I have done extensive testing but there may still be a few bugs. If you find anything that isn’t working correctly, if you have comments or suggestions, or if you think there may be some way we can collaborate please feel free to message me! I am warmly open to any criticism.

Features

  • Change the ingredients required to craft items.
  • Block Items from being crafted or viewed
  • Change items crafting rate.
  • Create custom item categories or change an item's category. (Ammunition, Construction, Tool, etc)
  • Enable crafting for ALL (typically uncraftable) items. Example: LR300, M249, all types of food, water, blood, and more.
  • Rename items in the crafting UI
  • Change the icon of items in the crafting UI
  • Customizable hotkey to bring up the UI
  • Disable crafting in stock crafting UI

Chat Commands

  • /craftui
    Lists all available commands
  • /craftui.add "amount" "Ingredient Name" "Item Name"
    Adds a given amount of ingredients to an item
    Example: /craftui.add 25 "High Quality Metal" "Assault Rifle"
  • /craftui.remove "amount "Ingredient Name" "Item Name"
    Removes a given amount of ingredients from an item
    Example: /craftui.remove 50 Wood Hammer
  • /craftui.ingredients "Item Name"
    Lists the ingredients required for an item
    Example: /craftui.ingredients "Research Table"
  • /craftui.clearingredients "Item Name"
    Clears ALL ingredient requires for an item
    Example: /craftui.clearingredients Rocket
  • /craftui.resetingredients "Item Name"
    Resets ingredients of an item to their defaults
    Example /craftui.clearingredients "Rocket"
  • /craftui.block "Item Name"
    Blocks an item from being crafted AND VIEWED in the crafting UI
    Example: /craftui.block "Wooden Arrow"
  • /craftui.unblock "Item Name"
    Unblocks an item from being crafted
    Example: /craftui.unblock "Wooden Arrow"
  • /craftui.blockall
    Blocks ALL items from crafting
  • /craftui.unblockall
    Unblocks ALL items from crafting
  • /craftui.rename "Item Name" "New Name"
    Renames an item in the CUSTOM CRAFTING UI ONLY
    Example: /craftui.rename "Wooden Arrow" "Fire Arrows"
  • /craftui.description "Item Name" "New Description"
    Gives a custom description to an item in the CUSTOM CRAFTING UI ONLY
    Example: /crafui.description "Wood Arrow" "Bad ass Fire Arrows"
  • /craftui.seticon "Item Name" "URL"
    Sets the icon of an item in the CUSTOM CRAFTING UI ONLY
    Example: /craftui.seticon "Hide Boots" "http://www.somesite.com/myimage.png"
  • /craftui.category "Item Name" "Category Name"
    Sets the category of an item. (Ammunition, Construction, Items, etc.)
    Example: /craftui.category "Hide Boots" "Ammunition"
  • /craftui.save
    Saves your current item changes (also done when plugin unloaded)
  • /craftui.load
    Loads item data. Note: this will overwrite any unsaved changes

Configuration

"Allow Old Crafting" - false disables crafting any item from the Facepunch Crafting UI, true enables crafting from the Facepunch Crafting UI. (Default false

"Category Names" - A list of category names to display on the left side of the GUI. An items "category" field must match one of these category names in order to be displayed.

"Include Uncraftable Items" - true allows ALL items (bear meat, water, blood, components, etc) to be crafted by the player. These items all default to 0 ingredient cost and a 30s craft time. They will need to be individually set per the admin's desires. (Default: false)

"Item Icon Size" - The pixel size of items in the GUI. Larger will make items higher resolution but take longer to load. (Default 150)

"Open CraftUI Binding" - set a custom key to open CraftUI. When a player joins the server this key will be rebound to open the ui and reset to it’s default value when they leave the server. (Default "q")

"Item List" - These values will be automatically created after the plugin has been loaded at least once. It is a list of every item in the game and their custom names, descriptions, ingredients, craftrates, etc. Please make sure the plugin is UNLOADED before editing this list.

Credits

  • EinTime, for the original version of this plugin
  • Orange, for helping maintain the plugin
  • sami37, for the fixed temporaty version

MIT License


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.