Overview
Smithy requires no global configuration and all of its controls are contained within Adapters, but Smithy comes with two management windows designed to make using Smithy even easier.
The management tools are located in the Unity Editor menu bar, under Window Smithy
Smithy Manager
The Smithy Manger contains Smithy's automated repair tools, as well as a report generator that can export information about adapters and nodes.
Accessed from the Unity Editor menu bar under Window Smithy Smithy Manager or by pressing Ctrl + Shift + M
Contact Links
Links to contact methods, Unity Forum and Asset Store pages, and this documentation can be found on the left side of this window. Clicking any of these links will open a new browser window. The same links can be found at this documentation's index page.
Object Browser
The Object Browser will find and list all prefabs that contain a Smithy adapter. Clicking one of the objects in this panel will select the prefab in the Unity Project View
If an object in your project is not appearing in the object browser, check to make sure it has an adapter component, and is saved as a prefab. If that still doesn't work, open the repair panel.
Diagnose and Repair
Smithy will warn you about about configurations that could result in suboptimal generation or nodes that fail to generate under any circumstances.
This tool searches all Smithy-enabled prefabs and lists those warnings. On the right side of the report, there are two wrench icons:
Standard Repair
Smithy will attempt to repair all assets with outstanding issues.
Specifically: - It will remove missing materials from material options lists, - It will remove plug tags that aren't attributed to any socket - It will remove socket tags that aren't attributed to any plug
Aggressive Repair
Smithy will attempt to repair all assets with outstanding issues. It will destroy nodes that cannot spawn.
Aggressive repair will repair the same issues that standard repair does, but it will also destroy any nodes that have not been assigned tags, or whose tags have been deleted from the project's tag array. It will also destroy nodes that have been rendered tagless because of the removal of orphaned tags.
Generate Report
The report window will generate a detailed report of all saved adapters, their nodes, and details about each node. Please remember that Smithy cannot select an adapter unless it is saved in a GameObject prefab.
The report in this window can be saved as an HTML file by clicking the button.
Probability Preset Manager
The Probability Preset Manager is a tool to achieve consistent generation results over any number of plugs and sockets. In this window you are able to add, edit, and delete presets that contain selection weight and percentage values.
When editing nodes, these values can be assigned instantly by clicking the preset icon.
Clicking the button in the bottom right corner of the window will save the current preset list for use in the project.
The button in the lower left corner will revert the preset list to the default list that comes with the Smithy Asset.
Clicking the in the window bar will exit the manager and discard any unsaved changes.
Accessed from the Unity Editor menu bar under Window Smithy Preset Manager or by pressing Ctrl + Shift + R
Presets
Presets hold a selection weight and a fill probability. When saved, they will appear in node generation probability panels. Clicking their icon will set plug nodes to the preset weight value, and selection nodes to the preset fill probability.
Presets are usually displayed in Smithy by their icon, and icons can be set by clicking the button that is superimposed on the preset icon. Doing so will open the following window:
The first row of sliders set the red, green, and blue values for the icon's foreground color.
The second row sets the red, green, and blue values for the icon's background color.
The lower panel of this window sets a Font Awesome glyph as the preset's icon.
To add a new preset to your project, click the button.
Visualizer
The visualizer updates automatically as you add, remove, or edit presets.
The right half of the preset manager window is a selection weight visualizer. Smithy simulates 10,000 selections (by default) and reports how often each preset was selected. By hovering over a column of the bar chart Smithy will report how often that preset has been selected, and the relative probability of that preset being selected.
The integer input in the upper right-hand corner represents the number of selections the simulation makes while updating. Higher values result in more accurate results, but are more performance-intensive and may result in lag when using this manager.