Beginners Guide

This beginner's guide will introduce you with the general process into creating new GEAR items through the ModComponent SDK. This guide will only go through the basics of creating a prefab and exporting you mod, so it's fully functional.

This guide however will not cover more 'advanced' components such as Blueprints or Gear Spawns - however they are quite easy to understand and pick up without a tutorial.

WARNING

Before proceeding, please make sure that you have set up everything from the Unity Setup guide.

This tutorial also assumes that you grasped the basics of Unity.

Creating a New Mod

Step 1: Validating Project

• This is a crucial step as this mod heavily depends on all the assets generated. To ensure this step has been completed, navigate to ModComponentSDK > Validate Project, and import all the Data Assets if you haven't done so already.

Step 2: Creating a New ModDefinition

• Now navigate to ModComponentSDK > New Mod Definition. Then enter the name of your mod and the author. This will then create a new folder at Assets/_ModComponent/{YOUR MOD NAME HERE}.

Step 3: Adjusting ModDefinition Fields

• From here you can navigate to your newly created ModDefinition asset file. You can then manipulate the other fields provided to you. You will also notice a Localization asset file, we will come back to this later.

---

Creating a New GEAR Item

Step 4: Creating Workspace Folder

• Now we can actually move onto creating a new GEAR item. First we need to define a new folder to put all of our stuff, this includes Meshes, Textures, Materials, Prefabs, etc. For this tutorial we will be putting everything within a new folder created at the Assets root folder. So at Assets/TutorialMod.

INFO

While organising everything within your assets folder is optional, it's recommended for an easier workflow process. You could copy the image above as an example.

DANGER

DO NOT put your assets for this mod within the same folder in which the ModDefinition was created.

Step 5: Importing Assets

• Once you have created your workspace folder and it's layout. Import any assets you will be using for your GEAR item, this includes any meshes or textures.

Step 6: Creating a new Prefab

• Now that all the assets are imported, we can get to the good stuff - actually creating the GEAR prefab item. To begin, right-click in your Prefabs folder (or however you've set up your workspace) and select Create > Prefab. From here, name it according to what the item is. In my case it'll be called GEAR_Cube. From here, double-click the prefab - this will bring you into the prefab's workspace.

WARNING

Its crucial that you have the prefab named with the prefix of GEAR_.

Step 7: Adding the Mesh & Textures

• Once you have opened up the workspace for your prefab by double-clicking on it, navigate back to where you imported your mesh. Once you have, drag and drop it onto your prefabs parent object. In my case it'll be GEAR_Cube that I'm dropping my mesh onto.
• After doing so, you'll notice that your mesh has no textures. Navigate to where you imported your texture, then drag and drop it onto the mesh you just dragged in. It should then create a new Material for you somewhere in your workspace. Navigate to it and bring down the Smoothness slider down to 0.

Step 8: Adding colliders.

• From the hierarchy panel, select the root of your prefab again. In my case it's GEAR_Cube, then on your Inspector panel on the right, select the Add Component button and search for collider. Select any collider which will suit the shape of your item the best and apply it. Resize the collider appropriately.

DANGER

Make sure that the collider is on the root GameObject which for me is GEAR_Cube and NOT the mesh GameObject.

Step 9: Adding functionality.

• Now onto the fun stuff. On the same root GameObject, select the Add Component again and search for Mod. This will bring up every Component, Behaviours and Blueprints available to use on your new GEAR item. For this example, we will only be attaching the ModGenericComponent to our prefab.
• Adjust the different fields to your liking, so go crazy! You can view what I have set my fields to under each category below.
• After doing all that, make sure to have your prefab by holding CTRL + S.

Exporting

Step 10: Adding Prefabs and Texture to the ModDefinition

• Now you have officially created your first GEAR item! Now navigate back to your Mod Definition asset that was created at the beginning. Notice the two fields GEAR Prefabs and Inventory, Crafting & Paperdoll Textures. Now we need to expand those fields and add our new prefab and inventory texture which we created and imported earlier.

Step 11: Opening Mod Manager

• Now we need to open the Mod Manager, so we can view the contents of our mod, and so we can export it. Navigate to ModComponentSDK > Mod Manager and dock it somewhere in your project as you will use it quite often. From there you should see your newly created Mod Definition and the prefabs and textures which we recently attached to the Mod Definition.

INFO

If you don't see anything, click the refresh button - otherwise you must've screwed up a step.

Step 12: Exporting Mod

• One all of that has been done, select your Mod Definition within the Mod Manager. This will allow you to export your selected mod by clicking the export mod button. From there choose a location to save your .modcomponent and launch The Long Dark!