← Back to Home

In This Article:

🤔 Notice something is missing or not working? → Please contact Zoel (zoelbastianbach@agate.id) on Ms. Teams!

Overview

A good project structure can communicate where to find certain files and assets to the team, regardless the size or the complexity level of the project.

• ❓ Why should I care about this article?
• 🎯 The goal of this article
• 🤷🏻 If I have further question about this article, who can I reach out to?

Folder Structure

• All files within the same scope should be stored inside one root folder

  For example:

  <aside> 📂 Assets (expand toggle)

  • Game
  • Plugins
  • ... </aside>

• Be aware of Default Folders or Special Folders used and reserved by engines

  • For example, take a look at Unity Special Folders. In Unity, you must place Editor scripts in a folder called Editor for them to work correctly.

• ❌ DO NOT use space (" ") in folder name

  • ❓ Why? → there could be plugins that may not work well with spaces on the folder name. Not using space will help reduce issues encountered as it will always work regardless of the plugins

• ✅ DO organize by modules, just as with namespaces (Learn more about Namespace Standard)

  • ❌ WRONG example

    <aside> 📂 Game (expand toggle)

    • Scripts </aside>

    ❓ Why is this wrong? → this reduce the modularity of each functionality developed, making them hard to reuse as they're scattered all over the place. You have to find a functionality related file in each component type (Controller, View, etc.)

  • ✅ CORRECT example

    <aside> 📂 Game (expand toggle)

    • Scripts </aside>

    ❓ Why? → now it's easier to, say, reuse the ModuleA for another project. Everything is in one place.

• You can also create folders for submodules, nested in its parent module folder

  <aside> 📂 Scripts (expand toggle)

  • ModuleA
  • ... </aside>

• Golden rule is, if a folder contains more than 10 items, there might be a way to categorize the items even further

  • Rather than this...

    <aside> 📂 Gameplay

    • Controller
    • ... </aside>

  • Try this (if appropriate)

    <aside> 📂 Gameplay

    • GameplayFlow
    • GameplayHint
    • GameplaySetup
    • ... </aside>

• ✅ TRY to match module's folder name with its namespace

  • ❓ Why? → Folder Structure and Namespace should be able to communicate the structure of the project, to make it more predictable and easier when needed to access the files

See Also

Coding Standard

Naming Standard

Namespace Standard

Git Usage Standard

Back to Top ⬆️