Project Structure

Overview

This page outlines the directory structure and naming convention used in Project Silence. This structure is designed to help organize the project files and assets in a way that is easy to navigate and understand. By following this structure, team members can quickly find the files they need and ensure that the project remains organized throughout development.

Directory Structure

The directory structure for Project Silence is as follows:

Project Silence/
├── Code
├── Docs
│   ├── DesignDocs
│   ├── Screencaps
├── Houdini
│   ├── Templates
│   ├── ProjectSilenceAssets
├── Media
│   ├── Logos
│   ├── Renders
│   ├── ScreenCaps
│   ├── Scripts
│   ├── Storyboards
│   ├── MarketingAssets
│       ├── Audio
│       ├── Logos
│       ├── Renders
│       ├── ScreenCaps
│       ├── Videos
├── Resources
│   ├── 2DAssets
│   ├── 3DModels
│   ├── Audio
│   ├── MegascansLibrary
│   ├── References
│   ├── Textures
│   ├── VFX
│   ├── Videos
├── SourceContent
│   ├── Audio
│   ├── Character
│   ├── Enemy
│   ├── Environment
│   ├── Meshes
│   ├── Tools
│   ├── UI
│   ├── VFX
├── Unreal
    ├── ProjectTemplate
    ├── ProjectSilence

Naming Convention

The naming convention used in Project Silence follows a consistent pattern to help team members quickly identify the contents of each file or folder. The convention is as follows:

Folders

Folder names are written in PascalCase, with the first letter of each word capitalized. For example, DesignDocs, Screencaps, Storyboards.

Some exceptions to this rule include folders like 2DAssets, 3DModels, VFX and UI, which are named based on their most common terminology.

Assets

File names are also written in PascalCase, with the first letter of each word capitalized. For example, BP_MainCharacter.uasset, BP_StealthMechanics.uasset. The file extensions are always lowercase.

Each file is prepended with a prefix that indicates the type of file it is. For example, BP_ for Blueprint files, SM_ for Static Meshes, MAT_ for Materials, T_ for Textures, SFX_ for Sound FX, and so on. These prefixes match UE5's naming conventions found here UE5 Naming Conventions.

A good example of the structure (from the site above) is:

[AssetTypePrefix]_[AssetName]_[Descriptor]_[OptionalVariantLetterOrNumber]

This helps maintain consistency for assets and help team members quickly identify the type of file they're looking for and are working with.

Version Control

Project Silence uses Git for version control. The repository is hosted on GitHub and follows the standard Git workflow. Team members are expected to follow the guidelines outlined in the project's version control policy to ensure that changes are tracked, reviewed, and merged correctly.

Documentation

All project documentation is stored in the Docs folder. This includes design documents, scripts, storyboards, and other project-related files. By keeping all documentation in one place, team members can easily access the information they need and ensure that everyone is working from the most up-to-date materials.

Marketing Assets

Marketing assets, such as logos, renders, and screenshots, are stored in the MarketingAssets folder. These assets are approved material used for promotional purposes, such as creating trailers, social media posts, and other marketing materials. By keeping these assets organized, team members can quickly find the files they need when creating marketing content. Anything outside of this folder should not be used for marketing purposes until going through an approval process. After approval, by the appropriate lead(s), a copy of the assets can be moved to the MarketingAssets folder.