7 Most Important Things to Keep Your Unity Project Organized

This post has originally been published on The Knights of Unity blog (http://blog.theknightsofunity.com/7-ways-keep-unity-project-organized/) by Piotr Korzuszek. More awesome Unity tutorials, tips and tricks on our Blog: http://blog.theknightsofunity.com/

I saw a person on Quora the other day, asking how programmers are able to write projects that consist of over 10 000 lines of code. When software gets bigger, it is more difficult to maintain and that's a fact. So here's the thing - if you won't keep your project organized, you're going to have a hard time to keep the pace. Later on, you will find yourself wasting time with messy project instead of adding new features. This is also true regarding any Unity Project. Here are (in my opinion) most important tips that will help you with keeping your project organized.

1. Directory Structure

We cannot talk about organization without mentioning organizing project directory structure. Unity gives you a total freedom in that matter, but because of that, it can frequently get really messy. This is the directory structure I personally use:

2. Scene hierarchy structure

Next to the project's hierarchy there's also scene hierarchy. As before, I will present you a template. You can adjust it to your needs.

There are several rules you should follow:

3. Use prefabs for everything

Prefabs in Unity are not perfect, but they are the best thing you will find to share pre-configured hierarchies of objects. Generally speaking, try to prefab everything that you put on your scenes. You should be able to create a new level from an empty scene just by adding one or more prefabs to it.

The reason why you should use prefabs is that when a prefab change, all the instances change too. Have 100 levels and want to add a camera effect on all of them? Not a problem! If your camera is a prefab, just add a camera effect to the camera prefab!

Be aware that you cannot have prefab in another prefab. Use links instead - have a field that requires a prefab to be assigned and make sure to assign it when instance is created. Consider auto-connecting prefab instances in Awake() or OnEnable() when it makes sense.

4. Learn how to use version control system (VCS)

[email protected]" style="border-style:solid; border-width:1px; float:left; height:92px; margin:5px; width:220px" />You may already know something about GIT, Subversion or any other VCS out there. As a matter of fact, "knowing something" is only a small piece of what you may learn. You should focus on learning about important but infrequently used features of VCS of your choice. Why? Mostly because VCS systems are much more powerful that you think, and unfortunately many users are using these as nothing more than a backup and synchronized solutions. For example, did you know that GIT allows you to stash your changes, so you can work on them later without commiting anything to your master branch?

Programmers tend to comment out blocks of code in case it's needed later. Don't do that! If you're using VCS learn how to quickly browse previous versions of a file. When you are familiar with it, your code looks a lot nicer without unnecessary block of commented code.

Here's a nice resource of tips for GIT users: http://gitready.com/

5. Learn to write editor scripts

Unity is a great game engine in the matter of extensibility (see Asset Store). Learn how to write editor scripts and utilize this knowledge. You don't necessary need to create fancy GUI for your scripts, it can be something simple, as menu entries that are doing something useful. Here are some examples of editor scripts that I have created not so long ago:

You can learn how to create editor scripts from the official documentation.

6. Learn to program defensively

Have you heard about defensive programming? Wikipedia defines it as follows:

Generally when you're writing MonoBehaviours, you should make sure that:

For many of these checks you can use asserts. You should also read A Story of NullPointerException Part 1 and 2.

7. Implement in-editor and/or in-game cheats

After you learn how to write editor script, you should be able to write a set of in-editor cheats. It can work as menu entry that unlocks something (all levels for instance). It's really easy to create:

class Cheats
{
    [MenuItem("My Game/Cheats/Unlock All Levels")]
    public static void UnlockAllLevels()
    {
        if (Application.isPlaying)
        {
            // unlock code here...
        } else {
            Debug.LogError("Not in play mode.");
        }
    }
}

Generally you should write cheats that will allow you to:

Of course more practical (but harder to write) are in-game cheats. These type of cheats can be executed outside Unity editor, but you have to think how you would like to execute it. See our other article about implementing cheats subsystem controlled by mouse.

This post has originally been published on The Knights of Unity blog by Piotr Korzuszek. More on http://theknightsofunity.com/