Creating Custom Blocks
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 here as well as the asset files needed to complete this tutorial. https://github.com/StrangeLoopGames/EcoModKit/tree/examples/Examples/Blockset
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.
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.
Creating your first BlockBuilder
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
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.
Common Bugs
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.
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.
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.
