# allar/ue5-style-guide

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/allar-ue5-style-guide).**

6,230 stars · 1,257 forks · MIT

## Links

- GitHub: https://github.com/Allar/ue5-style-guide
- Homepage: http://ue5.style
- awesome-repositories: https://awesome-repositories.com/repository/allar-ue5-style-guide.md

## Topics

`blueprint` `lint` `linter` `linters` `linting` `naming-conventions` `style-guide` `styleguide` `udk` `udk4` `ue4` `unreal` `unreal-engine` `unreal-engine-4` `unreal-marketplace` `unrealengine`

## Description

This is a community-driven style guide for Unreal Engine 5 projects, providing a comprehensive set of conventions for organizing content and writing Blueprint code. The guide establishes standards for project folder structure, asset naming, and Blueprint scripting to improve readability, maintainability, and team collaboration.

The guide covers two main areas: project organization and Blueprint coding standards. For project organization, it recommends structuring content by gameplay feature rather than asset type, isolating project assets in a top-level folder, using PascalCase for folder names, placing all maps in a dedicated folder, and using Developer folders for experimental assets. For Blueprint coding, it establishes naming conventions such as prefixing boolean variables with a lowercase "b" and naming functions as present-tense verbs.

The documentation provides clear, actionable rules for asset naming with type-specific prefixes, folder structure, and variable naming that help teams avoid migration conflicts, reduce namespace pollution, and make assets instantly identifiable in content browsers.

## Tags

### Software Engineering & Architecture

- [Unreal Engine Project Structures](https://awesome-repositories.com/f/software-engineering-architecture/project-structure-organization/unreal-engine-project-structures.md) — Standardizes folder structure and asset naming across Unreal Engine projects for team collaboration.
- [Feature-Based Project Structures](https://awesome-repositories.com/f/software-engineering-architecture/feature-based-project-structures.md) — Organizes project assets into feature-based folders rather than type-based folders to reduce redundancy. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))
- [Verb-Based Function Names](https://awesome-repositories.com/f/software-engineering-architecture/functional-design-patterns/function-naming-patterns/verb-based-function-names.md) — Establishes a verb-first naming rule for all Blueprint functions and events. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))
- [Blueprint](https://awesome-repositories.com/f/software-engineering-architecture/naming-conventions/blueprint.md) — Applies consistent naming rules for Blueprint assets, variables, and functions to improve readability.
- [PascalCase Folder Names](https://awesome-repositories.com/f/software-engineering-architecture/development-methodologies/engineering-best-practices/code-craftsmanship-standards/coding-standards/naming-conventions/component-naming/component-name-transformations/folder-character-transformation/pascalcase-folder-names.md) — Mandates PascalCase for all folder names to avoid tool and platform compatibility issues. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))
- [Developer Folder Isolation](https://awesome-repositories.com/f/software-engineering-architecture/execution-control/namespace-isolation/module-isolation/architecture-isolation/logic-isolation/source-code-isolation/experimental-code-isolation/developer-folder-isolation.md) — Stores work-in-progress assets in Developer folders to prevent accidental use of unfinished content in builds.
- [Developer Folder Isolation](https://awesome-repositories.com/f/software-engineering-architecture/experimental-project-development/developer-folder-isolation.md) — Stores work-in-progress assets in a Developer folder to prevent accidental use of unfinished content. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))
- [Single-Folder Project Layouts](https://awesome-repositories.com/f/software-engineering-architecture/project-management-governance/repository-maintenance/project-organization/single-folder-project-layouts.md) — Recommends placing all project assets under a single top-level folder to prevent migration conflicts. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))

### Part of an Awesome List

- [Boolean Prop Naming](https://awesome-repositories.com/f/awesome-lists/devtools/pattern-matching/code-naming-patterns/boolean-prop-naming.md) — Defines a naming convention for boolean variables using a b prefix in Blueprint scripts. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))

### Content Management & Publishing

- [Type-Prefixed Asset Names](https://awesome-repositories.com/f/content-management-publishing/asset-naming-rules/type-prefixed-asset-names.md) — Defines type-specific prefixes for all asset names to enable instant identification in content browsers. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))

### Game Development

- [Level File Organization](https://awesome-repositories.com/f/game-development/level-file-organization.md) — Requires all level files to be stored in a dedicated Maps folder for simplified navigation and builds. ([source](https://cdn.jsdelivr.net/gh/allar/ue5-style-guide@main/README.md))