lucastucious/ue4-style-guide
1
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

Mise à jour de 'README.md'

Browse source
This commit is contained in:
Lucas 2019-11-04 12:12:15 +00:00
parent fc6c5555a4
commit 9576381482
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -121,7 +121,7 @@ Gamemakin LLC is not a lawyer, but please don't introduce illegal actions and be
<a name="anc"></a>
<a name="1"></a>
## 1. Asset Naming Conventions ![#](https://img.shields.io/badge/lint-partial_support-yellow.svg)
## 1. Asset Naming Conventions
Naming conventions should be treated as law. A project that conforms to a naming convention is able to have its assets managed, searched, parsed, and maintained with incredible ease.
@ -129,7 +129,7 @@ Most things are prefixed with prefixes being generally an acronym of the asset t
<a name="base-asset-name"></a>
<a name="1.1"></a>
### 1.1 Base Asset Name - `Prefix_BaseAssetName_Variant_Suffix` ![#](https://img.shields.io/badge/lint-partial_support-yellow.svg)
### 1.1 Base Asset Name - `Prefix_BaseAssetName_Variant_Suffix`
All assets should have a _Base Asset Name_. A Base Asset Name represents a logical grouping of related assets. Any asset that is part of this logical group should follow the the standard of `Prefix_BaseAssetName_Variant_Suffix`.
@ -170,7 +170,7 @@ Depending on how your asset variants are made, you can chain together variant na
<a name="asset-name-modifiers"></a>
<a name="1.2"></a>
### 1.2 Asset Name Modifiers ![#](https://img.shields.io/badge/lint-supported-green.svg)
### 1.2 Asset Name Modifiers
When naming an asset use these tables to determine the prefix and suffix to use with an asset's [Base Asset Name](#base-asset-name).
@ -202,7 +202,7 @@ When naming an asset use these tables to determine the prefix and suffix to use
<a name="anc-common"></a>
<a name="1.2.1"></a>
#### 1.2.1 Most Common ![#](https://img.shields.io/badge/lint-supported-green.svg)
#### 1.2.1 Most Common
| Asset Type | Prefix | Suffix | Notes |
| ----------------------- | ---------- | ---------- | -------------------------------- |
@ -222,7 +222,7 @@ When naming an asset use these tables to determine the prefix and suffix to use
<a name="anc-animations"></a>
<a name="1.2.2"></a>
#### 1.2.2 Animations ![#](https://img.shields.io/badge/lint-supported-green.svg)
#### 1.2.2 Animations
| Asset Type | Prefix | Suffix | Notes |
| ----------------------- | ---------- | ---------- | -------------------------------- |
@ -243,7 +243,7 @@ When naming an asset use these tables to determine the prefix and suffix to use
<a name="anc-ai"></a>
<a name="1.2.3"></a>
### 1.2.3 Artificial Intelligence ![#](https://img.shields.io/badge/lint-supported-green.svg)
### 1.2.3 Artificial Intelligence
| Asset Type | Prefix | Suffix | Notes |
| ----------------------- | ---------- | ---------- | -------------------------------- |
@ -258,7 +258,7 @@ When naming an asset use these tables to determine the prefix and suffix to use
<a name="anc-bp"></a>
<a name="1.2.4"></a>
### 1.2.4 Blueprints ![#](https://img.shields.io/badge/lint-supported-green.svg)
### 1.2.4 Blueprints
| Asset Type | Prefix | Suffix | Notes |
| ----------------------- | ---------- | ---------- | -------------------------------- |
@ -610,15 +610,15 @@ For example if your project requires pickups that can be placed in a level, ther
<a name="2.6"></a>
<a name="structure-assettypes"></a>
### 2.6 Do Not Create Folders Called `Assets` or `AssetTypes` ![#](https://img.shields.io/badge/lint-supported-green.svg)
### 2.6 Do Not Create Folders Called `Assets` or `AssetTypes`
<a name="2.6.1"></a>
#### 2.6.1 Creating a folder named `Assets` is redundant. ![#](https://img.shields.io/badge/lint-supported-green.svg)
#### 2.6.1 Creating a folder named `Assets` is redundant.
All assets are assets.
<a name="2.6.2"></a>
#### 2.6.2 Creating a folder named `Meshes`, `Textures`, or `Materials` is redundant. ![#](https://img.shields.io/badge/lint-supported-green.svg)
#### 2.6.2 Creating a folder named `Meshes`, `Textures`, or `Materials` is redundant.
All asset names are named with their asset type in mind. These folders offer only redundant information and the use of these folders can easily be replaced with the robust and easy to use filtering system the Content Browser provides.
@ -1127,19 +1127,19 @@ For example, `Zed Camera Interface` or `Zed Camera Interface | Image Capturing`.
<a name="3.4"></a>
<a name="bp-graphs"></a>
### 3.4 Blueprint Graphs ![#](https://img.shields.io/badge/lint-unsupported-red.svg)
### 3.4 Blueprint Graphs
This section covers things that apply to all Blueprint graphs.
<a name="3.4.1"></a>
<a name="bp-graphs-spaghetti"></a>
#### 3.4.1 No Spaghetti ![#](https://img.shields.io/badge/lint-unsupported-red.svg)
#### 3.4.1 No Spaghetti
Wires should have clear beginnings and ends. You should never have to mentally untangle wires to make sense of a graph. Many of the following sections are dedicated to reducing spaghetti.
<a name="3.4.2"></a>
<a name="bp-graphs-align-wires"></a>
#### 3.4.2 Align Wires Not Nodes ![#](https://img.shields.io/badge/lint-unsupported-red.svg)
#### 3.4.2 Align Wires Not Nodes
Always align wires, not nodes. You can't always control the size and pin location on a node, but you can always control the location of a node and thus control the wires. Straight wires provide clear linear flow. Wiggly wires wear wits wickedly. You can straighten wires by using the Straigten Connections command with BP nodes selected. Hotkey: Q