In this tutorial we’ll set up a crafting menu.
This tutorial is the start of a mini-series covering the crafting system.
We’ll set up:
- content types to separate materials (items)
- general crafting settings
- a menu requirement to check if the player knows any recipes
- a menu screen to craft
Setting up materials and recipes will be done in part 2 of the crafting tutorial mini-series.
This tutorial is based on the ORK 4 Unity Quickstart 3D tutorials, but can be used in any project.
Crafting Content Type #
We’ll start with adding a new content type for the crafting material items.
We don’t need to set up separate content types for the crafting recipes, since we can simply use the same types for the recipes as the items they create. You can set up separate types for recipes as well, if you want.
E.g.: All potions are part of the Potions content type – we can simply put all crafting recipes that create potions into the same content type.
Open the ORK editor, navigate to Content > Content Types and add a new content type.
- Name
Set to: Materials
Crafting General Settings #
Next we’ll set up the general settings for crafting, e.g. recipe layout.
Navigate to Inventory > Crafting Recipes and select the General Settings.
Default Recipe Layout #
Recipe layouts are used when we display a crafting recipe’s details. Menu screens, content types and crafting recipes can override the default layout.
Content #
The content defines the combined text of the layout. It uses text codes to add the different parts of the information (e.g. listing the ingredients).
- Text
Set to:
<b><color=#FFFF00FF><name></color></b>
<description>
<b>Ingredient</b>
<ingredients>
<b>Outcome</b>
<outcome>
Ingredient Text #
Defines how each ingredient is displayed. By default each ingredient is displayed in it’s own line, we’ll keep it that way.
- Default Content (Ingredient Text)
Set to: <icon> <name> (<quantity>/<quantityavailable>) - Use Not Available Text
Enable
In case not enough of the required ingredient is in the user’s inventory, we’ll display a different text (just the same information but in a red color). - Default Content (Not Available Text)
Set to: <color=#FF0000FF><icon> <name> (<quantity>/<quantityavailable>)</color>
Outcome #
Defines how each outcome is displayed. By default each outcome is displayed in it’s own line, we’ll keep it that way.
- Default Content (Outcome)
Set to: <icon> <name> (<quantity>/<quantityavailable>)
Critical Outcome #
Defines how each critical outcome is displayed. We don’t display the critical outcome in our layout, but we can still set it up.
- Default Content (Outcome)
Set to: <icon> <name> (<quantity>/<quantityavailable>)
Menu Requirement #
We’ll set up a menu requirement, since we only want the crafting menu to be available when we have crafting recipes.
Navigate to Menus > Menu Requirement and add a new requirement.
Base Settings #
- Name
Set to: Has Crafting Recipes - Knows Recipes
Enable
Crafting Menu Screen #
Navigate to Menus > Menu Screens and add a new menu screen.
We’ll use the same basic setup as the other menu screens of the quickstart tutorials, but allow notifications to see the item notifications from crafted items.
Base Settings #
- Name
Set to: Crafting
Settings #
- Remember Selection
Enable - Pause Notifications
Disable - Block Notifications
Disable - Block Flying Texts
Enable - Pause Game
Enable - Freeze Pause
Enable
Crafting Part #
The Crafting part is used to display crafting recipes.
Scroll down to the bottom of the settings to see the Add Menu Part button.
Click on the Add Menu Part button and select Crafting.
The default setup will already show all content types and sort them by name – we’ll change it to sort by ID.
Available Content Types #
- Sort By
Select: ID
Type Box Settings #
Lists the crafting types that are available.
- Type Display
Select: UI Box
The content types will be displayed in a UI box as a selection menu. - Box Display Mode
Select: Multi
The content types and recipe list will be displayed at the same time. - Type Box
Select: Menu Small - Add Back Button
Select: Last
The Type Content Layout settings handle the content displayed in the content type buttons, we’ll keep it at the default setup, displaying text and icon.
Recipe Box Settings #
Lists the crafting recipes from the selected crafting type.
- Display Recipe>Create
Select: Multi
We’ll display the create box at the same time as the types and recipes, but we’ll only use it to show the recipes information.
The actual crafting will be started in the recipe box. - Recipe Box
Select: Menu Big - Sort By
Select: ID - Add Back Button
Select: Last
The Recipe Content Layout settings have an Additional Content Layout added. Additional content can be used to e.g. show the quantity of an item. Since we don’t use consumable recipes, we can remove the additional content.
Click on Remove in the Additional Content Layout 0 settings.
Create Box Settings #
Optionally displays detailed information about a recipe using a recipe layout – can also be used us a crafting confirmation.
We’ll use it as a HUD, only showing information for the selected recipe. The actual crafting is started by accepting a recipe in the recipe box.
- Create Box Mode
Select: HUD - Create Box
Select: Menu Info
That’s it for the crafting menu screen.
Updating Overview Menu Screen #
Select the Overview menu screen and change the following settings.
Button List 0 #
We’ll add a new button to the button list part.
Copy Menu Item 1 (i.e. the inventory button). This’ll add the copy directly below it.
Change the newly added Menu Item 2 button.
- Menu Screen
Select: Crafting - Text (Button Content)
Set to: Crafting
We’ll also use the menu requirement we’ve set up. We only want the button to show when crafting recipes are available.
- Hide
Enable
The button will be hidden when the conditions aren’t valid.
Otherwise the button will be displayed but not useable. - Use Menu Requirement
Enable - Menu Requirement
Select: Has Crafting Recipes
Save Changes #
And that’s it!
Don’t forget to save your changes by clicking on Save Settings at the bottom of the editor.
Testing #
You can only test the menu if you’ve already added crafting recipes to your game.
If you’ve added them and the player knows one, you’ll be able to open the crafting menu.
The next part of the crafting mini-series will add material items and crafting recipes to the game.