Creating Custom Blocks - Revision history

172.68.234.39: The link to the completed tutorial wasn't working anymore, fixed with correct url

2025-08-05T19:49:55Z

The link to the completed tutorial wasn't working anymore, fixed with correct url

← Older revision		Revision as of 21:49, 5 August 2025
Line 1:		Line 1:
	[[File:Stained Glass Block.png\|frame]]		[[File:Stained Glass Block.png\|frame]]
	This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/~~examples~~/Examples/Blockset here] as well as the asset files needed to complete this tutorial.		This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/main/Examples/Blockset here] as well as the asset files needed to complete this tutorial.
	https://github.com/StrangeLoopGames/EcoModKit/tree/main/Examples/Blockset		https://github.com/StrangeLoopGames/EcoModKit/tree/main/Examples/Blockset
	== Initial Scene Setup ==		== Initial Scene Setup ==

Salbris: Started to add a few more steps to the tutorial.

2022-02-01T20:29:41Z

Started to add a few more steps to the tutorial.

← Older revision		Revision as of 22:29, 1 February 2022
Line 24:		Line 24:
	The naming of these block sets is important for the code step later in the tutorial. Eco associates client side object with code by matching the given name. To create the seven required BlockBuilders right click the Unity asset explorer and go to Create -> VoxelEngine -> CustomBuilder. Do this for all seven builders and name them matching the list above. Once you have all seven builders return to the BlockSet object you previously created and click "New Block" and assign your first BlockBuilder and repeat for all seven. The order in which these are added is not important.		The naming of these block sets is important for the code step later in the tutorial. Eco associates client side object with code by matching the given name. To create the seven required BlockBuilders right click the Unity asset explorer and go to Create -> VoxelEngine -> CustomBuilder. Do this for all seven builders and name them matching the list above. Once you have all seven builders return to the BlockSet object you previously created and click "New Block" and assign your first BlockBuilder and repeat for all seven. The order in which these are added is not important.

			== Add Meshes and materials to Builders ==
			For each block you created above select them and add your material just below where you assigned your builder.
			[[File:UnityBlockMatScreen.png\|none\|thumb]]

	== Common Bugs ==		== Common Bugs ==

162.158.146.34: Updated blockset example link.

2022-01-13T02:32:34Z

Updated blockset example link.

← Older revision		Revision as of 04:32, 13 January 2022
Line 1:		Line 1:
	[[File:Stained Glass Block.png\|frame]]		[[File:Stained Glass Block.png\|frame]]
	This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.		This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.
	https://github.com/StrangeLoopGames/EcoModKit/tree/~~examples~~/Examples/Blockset		https://github.com/StrangeLoopGames/EcoModKit/tree/main/Examples/Blockset
	== Initial Scene Setup ==		== Initial Scene Setup ==
	Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.		Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.
Line 13:		Line 13:
	[[File:Green Stained Glass BlockSet.png\|thumb]]		[[File:Green Stained Glass BlockSet.png\|thumb]]
	A BlockBuilder represents a single form of a block inside Eco and defines the rules and meshes used to display it in the world. For the purposes of this tutorial we will be creating seven BlockBuilder objects for our new BlockSet. This list includes three block forms and four builders to represent the various stack states.		A BlockBuilder represents a single form of a block inside Eco and defines the rules and meshes used to display it in the world. For the purposes of this tutorial we will be creating seven BlockBuilder objects for our new BlockSet. This list includes three block forms and four builders to represent the various stack states.

	* GreenStainedGlassWindow		* GreenStainedGlassWindow
	* GreenStainedGlassStacked1		* GreenStainedGlassStacked1
Line 24:		Line 23:

	The naming of these block sets is important for the code step later in the tutorial. Eco associates client side object with code by matching the given name. To create the seven required BlockBuilders right click the Unity asset explorer and go to Create -> VoxelEngine -> CustomBuilder. Do this for all seven builders and name them matching the list above. Once you have all seven builders return to the BlockSet object you previously created and click "New Block" and assign your first BlockBuilder and repeat for all seven. The order in which these are added is not important.		The naming of these block sets is important for the code step later in the tutorial. Eco associates client side object with code by matching the given name. To create the seven required BlockBuilders right click the Unity asset explorer and go to Create -> VoxelEngine -> CustomBuilder. Do this for all seven builders and name them matching the list above. Once you have all seven builders return to the BlockSet object you previously created and click "New Block" and assign your first BlockBuilder and repeat for all seven. The order in which these are added is not important.

Thetestgame at 19:57, 25 May 2021

2021-05-25T19:57:04Z

← Older revision		Revision as of 21:57, 25 May 2021
Line 6:		Line 6:
	[[File:BlockSetContainerStructure.png\|none\|thumb\|542x542px]]		[[File:BlockSetContainerStructure.png\|none\|thumb\|542x542px]]
	== Creating your BlockSet ==		== Creating your BlockSet ==

	The first step to implementing a block into your new BlockSetContainer is by creating a BlockSet object inside the Unity asset explorer. A BlockSet represents one block type within the project. It contains the BlockBuilder objects used to represent each form of the new block as well as visual properties about how it should be rendered. To create a new BlockSet right click inside the Unity asset explorer and click Create -> VoxelEngine -> BlockSet. The name of the newly created BlockSet file is not important for the mod to function however for best practice it should be named similar to the internal or display name of the new block. Once the file is created attach it to the BlockSetContainer made in the previous step.		The first step to implementing a block into your new BlockSetContainer is by creating a BlockSet object inside the Unity asset explorer. A BlockSet represents one block type within the project. It contains the BlockBuilder objects used to represent each form of the new block as well as visual properties about how it should be rendered. To create a new BlockSet right click inside the Unity asset explorer and click Create -> VoxelEngine -> BlockSet. The name of the newly created BlockSet file is not important for the mod to function however for best practice it should be named similar to the internal or display name of the new block. Once the file is created attach it to the BlockSetContainer made in the previous step.
	[[File:BlockSet Menu Location.png\|none\|thumb]]		[[File:BlockSet Menu Location.png\|none\|thumb]]


			== Creating your first BlockBuilder ==
			[[File:Green Stained Glass BlockSet.png\|thumb]]
			A BlockBuilder represents a single form of a block inside Eco and defines the rules and meshes used to display it in the world. For the purposes of this tutorial we will be creating seven BlockBuilder objects for our new BlockSet. This list includes three block forms and four builders to represent the various stack states.

			* GreenStainedGlassWindow
			* GreenStainedGlassStacked1
			* GreenStainedGlassStacked2
			* GreenStainedGlassStacked3
			* GreenStainedGlassStacked4
			* GreenStainedGlassCube
			* GreenStainedGlassFlatRoof


	~~== Creating~~ your first BlockBuilder ==		The naming of these block sets is important for the code step later in the tutorial. Eco associates client side object with code by matching the given name. To create the seven required BlockBuilders right click the Unity asset explorer and go to Create -> VoxelEngine -> CustomBuilder. Do this for all seven builders and name them matching the list above. Once you have all seven builders return to the BlockSet object you previously created and click "New Block" and assign your first BlockBuilder and repeat for all seven. The order in which these are added is not important.

Thetestgame at 19:21, 25 May 2021

2021-05-25T19:21:49Z

← Older revision		Revision as of 21:21, 25 May 2021
Line 1:		Line 1:
			[[File:Stained Glass Block.png\|frame]]
	This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.		This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.

	https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset		https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset
	== Initial Scene Setup ==		== Initial Scene Setup ==
Line 6:		Line 6:
	[[File:BlockSetContainerStructure.png\|none\|thumb\|542x542px]]		[[File:BlockSetContainerStructure.png\|none\|thumb\|542x542px]]
	== Creating your BlockSet ==		== Creating your BlockSet ==

			The first step to implementing a block into your new BlockSetContainer is by creating a BlockSet object inside the Unity asset explorer. A BlockSet represents one block type within the project. It contains the BlockBuilder objects used to represent each form of the new block as well as visual properties about how it should be rendered. To create a new BlockSet right click inside the Unity asset explorer and click Create -> VoxelEngine -> BlockSet. The name of the newly created BlockSet file is not important for the mod to function however for best practice it should be named similar to the internal or display name of the new block. Once the file is created attach it to the BlockSetContainer made in the previous step.
			[[File:BlockSet Menu Location.png\|none\|thumb]]

Thetestgame at 20:38, 24 May 2021

2021-05-24T20:38:29Z

← Older revision		Revision as of 22:38, 24 May 2021
Line 2:		Line 2:

	https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset		https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset

	== Initial Scene Setup ==		== Initial Scene Setup ==
	Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.		Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.
	[[File:BlockSetContainerStructure.png\|none\|thumb\|542x542px]]		[[File:BlockSetContainerStructure.png\|none\|thumb\|542x542px]]

	== Creating your BlockSet ==		== Creating your BlockSet ==

Line 15:		Line 13:
	== Common Bugs ==		== Common Bugs ==
	Below are a list of common bugs encountered while making custom blocks and how to solve them.		Below are a list of common bugs encountered while making custom blocks and how to solve them.

	==== My block does not appear using the right mesh or in the spot I placed it. ====		==== My block does not appear using the right mesh or in the spot I placed it. ====
	This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.		This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.
	[[File:OptimizeMeshData-Unity-PlayerSettings.png\|none\|thumb\|462x462px]]		[[File:OptimizeMeshData-Unity-PlayerSettings.png\|none\|thumb\|462x462px]]

	==== My block is changing changing between my material and a different material ====		==== My block is changing changing between my material and a different material ====
	This usually is caused by a conflicting name with a material inside the client. If this happens a simple rename of the material should resolve this. This is also true with similar issues relating to the block mesh.		This usually is caused by a conflicting name with a material inside the client. If this happens a simple rename of the material should resolve this. This is also true with similar issues relating to the block mesh.
			[[Category:Modding]]
			{{DEFAULTSORT:CreatingCustomBlocks}}

Thetestgame at 20:28, 24 May 2021

2021-05-24T20:28:56Z

← Older revision		Revision as of 22:28, 24 May 2021
Line 4:		Line 4:

	== Initial Scene Setup ==		== Initial Scene Setup ==
			Eco has special naming requirements for GameObjects within the mod scene. For blocks this involves a empty GameObject with the name "Blocks" and a BlockSetContainer attached. This object will contain all BlockSets used by your mod.
			[[File:BlockSetContainerStructure.png\|none\|thumb\|542x542px]]

	== Creating your BlockSet ==		== Creating your BlockSet ==

	=== Creating your first BlockBuilder ===
			== Creating your first BlockBuilder ==


	== Common Bugs ==		== Common Bugs ==
	Below are a list of common bugs encountered while making custom blocks~~/blocksets~~ and how to solve them.		Below are a list of common bugs encountered while making custom blocks and how to solve them.

	==== My block does not appear using the right mesh or in the spot I placed it. ====		==== My block does not appear using the right mesh or in the spot I placed it. ====
	This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.		This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.
			[[File:OptimizeMeshData-Unity-PlayerSettings.png\|none\|thumb\|462x462px]]

			==== My block is changing changing between my material and a different material ====
			This usually is caused by a conflicting name with a material inside the client. If this happens a simple rename of the material should resolve this. This is also true with similar issues relating to the block mesh.

Thetestgame: Initial skeleton

2021-05-24T20:20:43Z

Initial skeleton

New page

This page will walk you through the basics of adding custom blocks to Eco utilizing the Glass models found already in the game to make a Green Stained Glass block. A completed tutorial can be [https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset here] as well as the asset files needed to complete this tutorial.

https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset

== Initial Scene Setup ==

== Creating your BlockSet ==

=== Creating your first BlockBuilder ===

== Common Bugs ==
Below are a list of common bugs encountered while making custom blocks/blocksets and how to solve them.

==== My block does not appear using the right mesh or in the spot I placed it. ====
This should be automatically handled in 9.4's ModKit. However if the issue is still present uncheck the "Optimize Mesh Data" option inside Unity's Player Settings prior to exporting the mesh.