{"id":83230,"date":"2019-02-11T14:37:09","date_gmt":"2019-02-11T14:37:09","guid":{"rendered":"https:\/\/www.red-gate.com\/simple-talk\/?p=83230"},"modified":"2021-07-29T19:44:09","modified_gmt":"2021-07-29T19:44:09","slug":"basic-modding-with-unity","status":"publish","type":"post","link":"https:\/\/www.red-gate.com\/simple-talk\/development\/dotnet-development\/basic-modding-with-unity\/","title":{"rendered":"Basic Modding with Unity"},"content":{"rendered":"

You might occasionally hear about a game that can be \u2018modded.\u2019 But what does that mean? For starters, a mod<\/em> is simply a short version of the word \u2018modification.\u2019 In the context of video games, this means someone has taken time to modify a certain aspect of the game they are playing. This modification can occur by changing the model a character normally uses, editing text in the game, or changing out a music track. Some mods take it a step further by completely overhauling entire systems in the game such as the user interface or the character’s leveling mechanics.<\/p>\n

The power of a community and the ability to mod a game cannot be overstated. Mods allow players to tweak a game to their liking, add more things to do in the game, or just provide a laugh by replacing the dragon with a cartoon pony. However, it should also be noted that allowing mods is a difficult task. There’s a reason so few games allow mods. In this article, you won’t learn how to make your game moddable to the level of a game like Skyrim, but you can learn some of the basics of implementing modding capabilities. Within Unity, you’ll be shown simple methods of allowing users to change the text in your game as well as changing the current mesh an object is using.<\/p>\n

Setup<\/h2>\n

There’s nothing you need to do ahead of project creation, so just open Unity and make a new project as shown in Figure 1.<\/p>\n

<\/p>\n

Figure 1: Creating a new project.<\/p>\n

Name your project BasicMod, <\/em>specify a file path, and make sure it’s a 3D project. Once you’ve done all that, create the project. The form should resemble Figure 2.<\/p>\n

<\/p>\n

Figure 2: Naming the project.<\/p>\n

Of course, without any objects to modify there’s no game to mod at all. Start by creating some text on the screen. Go to the Hierarchy <\/em>window and click the Create<\/em> button. Choose UI->Text <\/em>to make a text object like Figure 3.<\/p>\n

<\/p>\n

Figure 3: Creating some text<\/p>\n

Next, you’ll need to position the text in a position where it can be easily seen. The location can be wherever you choose, but Figure 4 shows how to place the text in the upper-middle of the screen. In the Inspector <\/em>window set Pos X <\/em>to -10 and Pos Y <\/em>to 125. Then set the Width <\/em>variable to 500 and Height <\/em>to 150, this way there’s plenty of space for whatever text you wish to enter.<\/p>\n

<\/p>\n

Figure 4: Setting Text <\/em>to the correct position and size<\/p>\n

After this, create some placeholder text in the Text <\/em>field. It can be whatever you wish. Finally, change any of the text properties you wish to make it easier to read. The below example in Figure 5 places the font size <\/em>variable at 30 and sets the alignment <\/em>to the center.<\/p>\n

<\/p>\n

Figure 5: Setting up the text<\/p>\n

This will do for the game’s text object. Next, you’ll need a 3D object. The user may wish to change the object from a simple cube to something else. Start by clicking the Create <\/em>button again in the Hierarchy<\/em>. Navigate to 3D Object-Cube <\/em>to create a cube object in the world. Set both its Position X <\/em>and Position Y <\/em>fields to 0. Change its Rotation Y <\/em>field to 45 and set the scale to 5 for all three axes as shown in Figure 6.<\/p>\n

<\/p>\n

Figure 6: The Cube <\/em>object’s Transform <\/em>component<\/p>\n

Finally, create an empty object by selecting the Create <\/em>button then navigating to Create Empty<\/em>. Name this new object GameManager<\/em>. This is the object that will hold the script that makes this project run. There’s nothing more to do here in the Unity editor. Navigate to your Assets <\/em>window and create a new C# Script <\/em>as shown in Figure 7. Name this script ModScript<\/em>.<\/p>\n

<\/p>\n

Figure 7: Making a new C# script<\/p>\n

Once created, double click ModScript <\/em>to open Visual Studio and begin the coding process.<\/p>\n

The Code<\/h2>\n

To get started, add using UnityEngine.UI; <\/code>and using System.IO;<\/code> to the top of the script as shown in Figure 8. System.IO<\/code> is going to be very important for this project. You’ll use it to create a folder named Resources <\/em>as well as employ StreamReader<\/code> to read data from a file that the user creates. It will also be responsible for gathering file names, so the rest of the program knows which file to use. UnityEngine.UI<\/code> also has an important job but just has less going on. This will allow you to edit the text on the Text <\/em>object you created earlier.<\/p>\n

<\/p>\n

Figure 8: All require using statements.<\/p>\n

Only a few global variables will need to be declared for this project. Those variables are:<\/p>\n

public Text messageText;\r\npublic MeshFilter mf;\r\nprivate string pathToMods;<\/pre>\n
Finally, for the sake of cleanliness, you\u2019ll have three function calls that make up the Start<\/code> function. Write the following:<\/p>\n
DirectoryCreation();\r\nTextModding();\r\nMeshModding();<\/pre>\n
The Update<\/code> function will not see any use in this project, so you may delete it or comment it out. Once finished, the variable declarations and the Start<\/code> function should look like Figure 9.<\/p>\n
<\/p>\n
Figure 9: The code so far…<\/p>\n
Of course, the compiler doesn\u2019t like the fact that those three functions don’t exist. Fortunately for Visual Studio, it won’t stay that way. Start with the DirectoryCreation<\/code> function.<\/p>\n
void DirectoryCreation()\r\n{\r\n\tpathToMods = Application.dataPath + \"\/Resources\";\r\n\tif (!Directory.Exists(pathToMods))\r\n\t\tDirectory.CreateDirectory(pathToMods);\r\n}<\/pre>\n
Time for a little breakdown of what’s happening. First, the code sets the value of pathToMods<\/code>. This value is a file path, and the path in question is the Resources <\/em>folder within the path of the game. Of course, none of that will matter if the folder doesn’t exist. The next two lines check to see if there is a Resources <\/em>directory. If there isn’t, the folder will be created for you.<\/p>\n
Up next is where the fun begins. TextModding<\/code> is the function that will allow a user to modify the text in the game. The function goes like this:<\/p>\n
void TextModding()\r\n{\r\n\tstring[] textMods = Directory.GetFiles(pathToMods + \"\/\", \"*.txt\");\r\n\tif (textMods.Length == 1)\r\n\t{\r\n\t\tStreamReader reader = new StreamReader(textMods[0]);\r\n\t\tmessageText.text = reader.ReadToEnd();\r\n\t}\r\n\telse if (textMods.Length > 1)\r\n\t{\r\n\t\tint file = Random.Range(0, textMods.Length);\r\n\t\tStreamReader reader = new StreamReader(textMods[file]);\r\n\t\tmessageText.text = reader.ReadToEnd();\r\n\t}\r\n}<\/pre>\n
First, you create an array of strings called textMods<\/code>. What do you fill this array with? You gather a list of all files with the txt extension and get their paths. Next, a check is performed to see if there’s more than one text file. This is done in case the user has more than one txt file. If there’s only one txt<\/em> file, then you simply take that file, read the text inside it, and then apply that text to the Text <\/em>object in the game. If there’s more than one txt<\/em> file to choose from, Unity will choose one at random.<\/p>\n
So far, your two new functions, DirectoryCreation<\/code> and TextModding<\/code>, should look like Figure 10.<\/p>\n
<\/p>\n
Figure 10: DirectoryCreation and TextModding<\/p>\n
Next comes the ability to modify the current mesh on the Cube <\/em>object using a function called MeshModding<\/code>. Like before, it will find all files with the fbx<\/em> extension. If there’s more than one file, the program will randomly select one to use. However, this is where the similarities between this function and TextModding<\/code> end.<\/p>\n
void MeshModding()\r\n{\r\n\tstring[] meshModPaths = Directory.GetFiles(pathToMods + \"\/\", \"*.fbx\");\r\n\tstring modToUse = \"mod\";\r\n\tstring extensionToRemove = \".fbx\";\r\n\tif (meshModPaths.Length == 1)\r\n\t{\r\n\t\tmodToUse = Path.GetFileName(meshModPaths[0]);\r\n\t\tmodToUse = modToUse.Replace(extensionToRemove, \"\");\r\n\t\tmf.mesh = Resources.Load<Mesh>(modToUse);\r\n\t}\r\n\telse if (meshModPaths.Length > 1)\r\n\t{\r\n\t\tint file = Random.Range(0, meshModPaths.Length);\r\n\t\tmodToUse = Path.GetFileName(meshModPaths[file]);\r\n\t\tmodToUse = modToUse.Replace(extensionToRemove, \"\");\r\n\t\tmf.mesh = Resources.Load<Mesh>(modToUse);\r\n\t}\r\n}<\/pre>\n
The basic idea is still intact, but the execution is somewhat different. Notice the two additional string variables declared alongside the string array. Your modToUse<\/code> variable is simply the name of the mod to use, and you just give it a placeholder name. After this comes another string variable named extensionToRemove<\/code>. As it turns out, a function you use later doesn’t like having extensions in the name of the file to search for. To get around this, you just specify which part of the text you wish to remove from the variable and use Replace <\/em>to rid the variable of the extension.<\/p>\n
At the last line, you call Resources<\/code>.<\/em>Load<\/code> to load the fbx<\/em> file into the game. Recall the Resources <\/em>folder you had the program create thanks to DirectoryCreation<\/code>. This function will specifically search the Resources <\/em>folder in your game for whichever file you tell it to load. In this case, it’s whatever the name of the file stored in modToUse<\/code> would be minus the extension. As expected, you also specify that it will be loaded as a mesh to make Unity happy. Figure 11 shows the function.<\/p>\n
<\/p>\n
Figure 11: MeshModding <\/em>function<\/p>\n
This concludes the coding section of this project. To summarize, you have granted a user the ability to modify text by reading a txt<\/em> file that they create. You also allowed them to change the mesh of the object in the scene by placing an fbx<\/em> file in the Resources <\/em>folder. Close Visual Studio and head back to the Unity project.<\/p>\n
Finishing the Project<\/h2>\n
Select the GameManager <\/em>object in the Hierarchy<\/em> and drag ModScript <\/em>from the Assets <\/em>window into the Inspector<\/em>, attaching the script to the object as shown in Figure 12.<\/p>\n
<\/p>\n
Figure 12: Attaching ModScript <\/em>to GameManager<\/em><\/p>\n
Next, comes the assignment of the Message Text <\/em>and Mf<\/em> variables. Find your Text <\/em>object that you created earlier and drag that to the Message Text <\/em>field in the newly created ModScript <\/em>component. Then take the Cube <\/em>object and drag it to the Mf <\/em>field. Once you have these in place, the Inspector should look like Figure 13.<\/p>\n
<\/p>\n
Figure 13: Applying Text <\/em>and Cube <\/em>to their corresponding variables<\/p>\n
There’s nothing else that needs to be done now. Does this mean the project is finished? Well, yes and no. You can and should run the project in Unity to create the Resources <\/em>folder, but the project itself won’t do anything you haven’t already set up. But that’s the point. The idea is you create your base game, and then somebody else can come in later and modify certain aspects of it. In this case, go ahead and pretend to be that somebody. But first be sure to run the program so the Resources <\/em>folder is created as shown in Figure 14.<\/p>\n
<\/p>\n
Figure 14: That folder wasn’t there before…<\/p>\n
Begin by adding a mesh for the game to pull from. So long as the mesh is an fbx<\/em> file, the program will work just fine. This example will use a model of a barrel found here<\/a>. Once you’ve got your model, whether it be the barrel example or something else entirely, use Windows Explorer to navigate to the Resources <\/em>folder of your project. Place that fbx<\/em> file in this folder.<\/p>\n
The text modding functionality is even simpler. Simply create a new txt<\/em> file and place it somewhere in the folder. You may name the text file anything you like. Open the file and enter whatever text you wish as shown in Figure 15.<\/p>\n
<\/p>\n
Figure 15: Adding files to the Resources <\/em>directory and writing text to a txt file<\/p>\n
Now enter Unity once again. Your users wouldn’t normally see this, but Unity will detect these files and update the Assets <\/em>window. Now try running the game again. You should see the text change and the basic mesh of the Cube <\/em>object replaced with whatever you placed as shown in Figure 16. Note: you may need to edit the scale value of the object to better see the modded mesh.<\/p>\n
<\/p>\n
Figure 16: The (modified) game in action!<\/p>\n
Conclusion<\/h2>\n
As pointed out in the introduction, this is only meant to be a simple intro to the absolute basics of modding. But feel free to pat yourself on the back, for this small project you created has more modding capabilities than many games get, officially or otherwise. This example introduced you to allow other users to change some of the game text and meshes your game might use. Furthermore, it was simple too. If you’ve ever tried to mod a game yourself, you might find that it can be somewhat difficult. Here, the process has been simplified so those who wish to mod the project can do so quickly.<\/p>\n
Of course, how much further you would take this is up to you, and it all depends on if you even want to build your game with modding in mind. To do that you’ll need to create a system that works for you as well as other users. Perhaps you should have the game search for specific filenames? What about texturing a mesh? In this example, the mesh that you modded into your game used the texture the Cube <\/em>object did. If you can change out a 3D object, it stands to reason you can also change the texture attached to that object. Experiment and see what you can discover, both for yourself and your users.<\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
It’s even more fun to play a game when you can customize it, but creating such a game is more difficult for the game developer. In this article, Lance Talbert shows you how to add some simple modifications to games you create with Unity and VS. …<\/p>\n","protected":false},"author":317499,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[143538,53],"tags":[],"coauthors":[52549],"class_list":["post-83230","post","type-post","status-publish","format-standard","hentry","category-dotnet-development","category-featured"],"acf":[],"_links":{"self":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/83230","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/users\/317499"}],"replies":[{"embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/comments?post=83230"}],"version-history":[{"count":4,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/83230\/revisions"}],"predecessor-version":[{"id":83248,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/posts\/83230\/revisions\/83248"}],"wp:attachment":[{"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/media?parent=83230"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/categories?post=83230"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/tags?post=83230"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/www.red-gate.com\/simple-talk\/wp-json\/wp\/v2\/coauthors?post=83230"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}