From 3D Asset to Working Worktable - Revision history

WugWugg at 18:49, 30 April 2026

2026-04-30T18:49:27Z

WugWugg: /* Checkpoint */

2026-04-29T00:29:04Z

Checkpoint

← Older revision		Revision as of 02:29, 29 April 2026
Line 655:		Line 655:

	=== Checkpoint ===		=== Checkpoint ===

	~~# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.~~
	~~# Start the server and log in.~~
	~~# Type <code>/give Carpentry Table</code>.~~
	~~# Place the Carpentry Table down and interact to see the what can be crafted.~~
	~~# Find the newly added recipe under the name ''Market Stall.''~~
	~~# Type <code>/give Basic Upgrade 4</code>.~~
	~~# Put the basic upgrade into the table.~~
	# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same. '''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

	[[File:WikiDemo - Medieval Stall - Checkpoint -3.png\|thumb\|The Medieval Stall modded into Eco.]]		[[File:WikiDemo - Medieval Stall - Checkpoint -3.png\|thumb\|The Medieval Stall modded into Eco.]]

WugWugg: Done. This guide is long and probably too repetitive, but it will produce results!

2026-04-29T00:19:23Z

Done. This guide is long and probably too repetitive, but it will produce results!

Show changes

WugWugg: Aside from 1 test, the Preparing the 3D asset section is done.

2026-04-28T22:35:23Z

Aside from 1 test, the Preparing the 3D asset section is done.

← Older revision		Revision as of 00:35, 29 April 2026
Line 490:		Line 490:
	# Press the ''Setup World Objects'' button.		# Press the ''Setup World Objects'' button.
	# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>		# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
	# Select the <code>.prefab</code> ~~file~~ in the ~~project window~~.		# Select the <code>.prefab</code>.
			# In the ''Inspector'' panel find the ''Transform'' component.
			# Change this component's ''Rotation...''
			## ''X'' to ''0.''
			## ''Y'' to ''0.''
			## ''Z'' to ''0.''
			# In the ''Inspector'' panel find the ''Box Collider'' component.
			#Find the ''⋮'' icon (all the way to the right of the words ''Box Collider)'' and click on it.
			#Select ''Reset'' from the menu. This will regenerate the box collider now that the rotation has changed.
			#Look in the ''Inspector'' panel and find the ''World Object (Script)'' component.
			# That component has a checkbox ''Override Occupancy''. Check it.
			# A new field should've expanded below it called ''Size''.
			# Set the ''Size''... '''Note:''' This size similar to the size of the reference cube from earlier, but the Y and Z coordinates get flipped! So if in Blender it was <code>(1, 2, 3)</code> then in Unity its <code>(1, 3, 2)</code>. '''TODO: Test This'''
			## ''X'' to ''4''.
			## ''Y'' to ''3''.
			## ''Z'' to ''3''.
	# Select ''Objects'' from ''Hierarchy'' panel (left-side of the window).		# Select ''Objects'' from ''Hierarchy'' panel (left-side of the window).
	# Find the ''Modkit Prefab Container (Script)'' component.		# Find the ''Modkit Prefab Container (Script)'' component. This component was added earlier, if it's not there add it now.
	# Expand the ''Prefabs'' section in that component.		# Expand the ''Prefabs'' section in that component.
	# Click the ''+'' button to add an item to the list.		# Click the ''+'' button to add an item to the list.

WugWugg: Creating the world object, Preparing the 3D asset is good.

2026-04-28T21:29:06Z

Creating the world object, Preparing the 3D asset is good.

Show changes

WugWugg: Giving up for now.

2026-04-27T21:11:21Z

Giving up for now.

← Older revision		Revision as of 23:11, 27 April 2026
Line 343:		Line 343:
	== Create the World Object ==		== Create the World Object ==
	=== Preparing the 3D Asset ===		=== Preparing the 3D Asset ===
	WIP. Below is <u>incorrect</u>. The origin point of the object must be in the center, ~~bottom of~~ the ~~object~~. ~~Instructions~~ for ~~reference cube moving and origin moving will produce bad results!~~		WIP. Below is <u>incorrect</u>. The origin point of the object should be a (0.5, 0.5, 0.5). Need to remember to zero out any transforms (translation and rotation) that the world object build scrip applies in Unity.

			You must use "override occupancy" for the prefab to be placable. The offset is still magic to me, need to figure that out.

			Also the freeplace seems to use the center of the prefab, but the snap place uses the origin. Need to figure out how to use origin for both.
	# Open <u>Blender</u>.		# Open <u>Blender</u>.
	# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.		# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
Line 466:		Line 470:
	# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>		# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

	~~'''TODO:''' Explain that if the orgin point isn't at the bottom-left corner of~~ the ~~model, then ''~~World Object ~~(Script) > Occupancy Offset'' will need adjusted manually~~.		=== Scripting the World Object ===
			WIP: Need occupancy code.

	~~=== Scripting the World Object ===~~
	Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">		Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">
	using Eco.Core.Items;		using Eco.Core.Items;

WugWugg at 06:08, 27 April 2026

2026-04-27T06:08:04Z

← Older revision		Revision as of 08:08, 27 April 2026
Line 415:		Line 415:
	# Open the ''Object'' menu.		# Open the ''Object'' menu.
	# Hover ''Apply''.		# Hover ''Apply''.
	# Select ''All Transformations''.		# Select ''All Transformations''. '''TODO:''' Ensure this step doesn't alter the origin now that it's being place in bottom-center, 0.5m off ground
	# Open the ''File'' menu from the top toolbar.		# Open the ''File'' menu from the top toolbar.
	# Hover ''Export'' to open the sub-menu.		# Hover ''Export'' to open the sub-menu.

WugWugg: Added warning about WIP section

2026-04-27T04:56:42Z

Added warning about WIP section

← Older revision		Revision as of 06:56, 27 April 2026
Line 343:		Line 343:
	== Create the World Object ==		== Create the World Object ==
	=== Preparing the 3D Asset ===		=== Preparing the 3D Asset ===
			WIP. Below is <u>incorrect</u>. The origin point of the object must be in the center, bottom of the object. Instructions for reference cube moving and origin moving will produce bad results!
	# Open <u>Blender</u>.		# Open <u>Blender</u>.
	# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.		# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

WugWugg: WIP

2026-04-26T23:16:09Z

WIP

Show changes

WugWugg: Working on recipe code.

2026-04-21T19:20:52Z

Working on recipe code.

@@ Line 204: / Line 204: @@
 === Scripting the Item ===
-Registering the item in the code is as simple as:<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
+For a more complex mod, it would be wise to build it into a DLL. See [[Getting Started with Eco Modding in Visual Studio 2022]] for details on that.
 using Eco.Gameplay.Items;
 using Eco.Shared.Localization;
@@ Line 211: / Line 215: @@
 namespace WikiDemo
+{
      [Serialized] // Tells the save/load system this object needs to be serialized.
      [LocDisplayName("Market Stall")] // Defines the localized name of the item.
@@ Line 217: / Line 222: @@
      [LocDescription("A medieval market stall.")] //The tooltip description for the item.
      public partial class MedievalStallItem: Item { }
-}</syntaxhighlight>'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.
+    #endregion
 === Checkpoint ===
@@ Line 239: / Line 245: @@
 == Code the Item's Recipe ==
-BELOW IS ALL WIP~
+This section will be much simpler than the last. The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
-Talk about how the Item name in Unity and the class name in code is what joins the items. Must be exactly the same!
+'''Line 83:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a pre-existing vanilla table.
 === Checkpoint ===
@@ Line 249: / Line 330: @@
 == Create the World Object ==
 === Add to Unity Scene ===

← Older revision		Revision as of 20:49, 30 April 2026
Line 283:		Line 283:
	ingredients: new List<IngredientElement>		ingredients: new List<IngredientElement>
	{		{
	new IngredientElement("Wood", 40, typeof(~~Skill~~)),		new IngredientElement("Wood", 40, typeof(CarpentrySkill)),
	new IngredientElement(typeof(CottonFabricItem), 30, typeof(~~Skill~~)),		new IngredientElement(typeof(CottonFabricItem), 30, typeof(CarpentrySkill)),
	new IngredientElement(typeof(HempMooringRopeItem), 5, true)		new IngredientElement(typeof(HempMooringRopeItem), 5, true)
	},		},
Line 293:		Line 293:
	);		);
	this.Recipes = new List<Recipe> { recipe };		this.Recipes = new List<Recipe> { recipe };
	this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(~~Skill~~));		this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(CarpentrySkill));
	this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(~~Skill~~));		this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(CarpentrySkill));

	// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"		// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
Line 321:		Line 321:
	'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.		'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

	'''Line 30-32:''' Declares the input ingredients used for crafting. ~~<code>typeof(Skill)</code> gets mapped to the~~ <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings.<br>'''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.		'''Line 30-32:''' Declares the input ingredients used for crafting. <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings.<br>'''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

	'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.		'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.