Skip to main content

Unity Foldering Standardization

Upload In Progressthis article:

Overview


This Unity Foldering Standard is enforced to reduce confusion and prevent some issues when working with multiple role, especially when working in new project or when new crews joined the team. When working on new project, this standardization will help all lead to focus more on the product rather than standardization like this.

Scope


This standardization cover the Unity folder structure, what is the name and where to put something to the project. This standard applies to all persons working in the project.

Standard Foldering


Assets

The Assets folder is the main folder that contains the Assets used by a Unity project under the root folder.

Arts

  • ~Raws
  • Animations
  • Models
  • Textures

Sounds

  • ~Rawsf
  • BGMs
  • SFXs
  • Cues

Levels

  • Databases
  • Prefabs
  • Scenes

Scripts

  • Generated
  • Development
  • Editor
  • Runtime

Plugins

  • [Modules1]
  • [Modules2]
  • [Modules#]
  • [ThirdParties1]
  • [ThirdParties2]
  • [ThirdParties#]

Documents

The Documents folder is the main folder that contains all the documents related to the projects. This can also be the place for all images that was used for Readme.md for the project in root folder.

Packages

There can be some others things that needs to be collected as 1 subgroup under the same project group such as minigame. Create subgroup with name based on its needs.

  • Mini Games
  • Mini Research

For example—to create subgroup that contain all minigames that require another repositories:

  • lvup-service/EB-Metasims/Mini Games

tl-dr

+---Assets
|   +---GameName
|       +---Arts
|           +---~Raw		# BLEND files, mockup, psd, ai
|           +---Materials
|           +---Models		# FBX
|           +---Textures	# PNG files
|       +---Sounds
|           +---~Raw		# wav, audio editor project file
|           +---Ambiences
|           +---BGMs
|           +---SFXs
|           +---Cues		# Samples, Mixer and sound effects
|       +---Scripts
|           +---Generated
|           +---Development
|           +---Editor
|           +---Runtime
|               +---Arcades
|                   \---Plinko
|                   \---Slot
|                   \---CoinPusher
|       +---Level			# Anything related to game design in Unity
|           +---Databases		# Configuration files, localization text and other user files.
|           +---Prefabs
|           +---Scenes
|   +---Plugins
|       +---Arcades
|   +---Presets			# Audio & Texture compression setting presets
|   +---Settings			# Build script settings, Addressable asset settings
+---Docs			# Wiki, concept art, marketing material

Related Pages