Skip to content

Commit a588f40

Browse files
committed
doc: Update README.
1 parent d872262 commit a588f40

File tree

1 file changed

+53
-4
lines changed

1 file changed

+53
-4
lines changed

README.md

Lines changed: 53 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Most of the materials have been created in Substance Painter, which we also use
2929

3030
How to add or update items can vary depending on the asset, and will be specified in the next section. The principles are always the same:
3131

32-
- One Blender file may result in multiple exports. For example, `Plastic Posts.blend` exports to *Plastic Posts* and *Plastic Spacers*. The different exports are grouped by categories in the Blender file and have the same name as the exported FBX file.
32+
- One Blender file may result in multiple exports. For example, `Plastic Posts.blend` exports to *Plastic Posts* and *Plastic Spacers*. The different exports are grouped by categories in the Blender file.
3333
- Items of an FBX file all share the same material. There may be several materials because there are meshes with multiple material slots, but one material type is applied to all the items in the FBX with that material type.
3434
- If a Blender file has complex geometry that is baked down that cannot be implemented purely with modifiers, there will be additional categories with low-poly and hi-poly meshes. These need to be toggled when exporting.
3535

@@ -53,21 +53,70 @@ With that out of the way, here is a typical workflow for adding or updating item
5353

5454
The library assets can be found at [Assets/Library](Assets/Library). We'll go through each of the curated assets with a short description about how to deal with them.
5555

56-
### Plastic Posts
56+
### Posts
57+
58+
- `Plastic Posts.blend` contains both *Plastic Posts* and *Plastic Spacers*.
59+
- `Metal Posts.blend` contains *Metal Posts*, *Metal Hex Spacers* and *Metal Round Spacers*.
60+
61+
#### Plastic Posts
5762

5863
- **Source**: [`Posts/src~/Plastic Posts.blend`](Assets/Library/Posts/src%7E/Plastic%20Posts.blend)
59-
- **Reference**: [`/Posts/Plastic%20Posts.blend`](https://github.com/vbousquet/pinball-parts/blob/main/Posts/Plastic%20Posts.blend)
60-
- **FBX**: [`Posts/Plastic Posts/Plastic Posts.fbx`](Assets/Library/Posts/Plastic%20Posts/Plastic%20Posts.fbx)
64+
- **Reference**: [`/Posts/Plastic Posts.blend`](https://github.com/vbousquet/pinball-parts/blob/main/Posts/Plastic%20Posts.blend)
65+
- **Asset Folder**: [`Posts/Plastic Posts`](Assets/Library/Posts/Plastic%20Posts)
6166
- **Export**: Select items in the *Plastic Posts* category. The only difference between hi-poly and low-poly are the modifiers.
67+
- **Material**: We don't use an albedo texture for the plastic, because it should be easily customizable. The other maps aren't very important, but *edgeglowplastic* seems to work well.
6268
- **Notes**: There are two materials, *Plastic - Peg Red* and *Metal - Peg*, which need to be renamed to *Plastic* and *Metal* respectively. Only the plastic needs any exported textures, the metal is generic. The plastic however needs a **thickness map** as well.
6369

70+
#### Plastic Spacers
71+
72+
- **Source**: [`Posts/src~/Plastic Posts.blend`](Assets/Library/Posts/src%7E/Plastic%20Posts.blend)
73+
- **Reference**: [`/Posts/Plastic Posts.blend`](https://github.com/vbousquet/pinball-parts/blob/main/Posts/Plastic%20Posts.blend)
74+
- **Asset Folder**: [`Posts/Plastic Spacers`](Assets/Library/Posts/Plastic%20Spacers)
75+
- **Export**: Select items in the *Plastic Spacers* category. The only difference between hi-poly and low-poly are the modifiers.
76+
- **Material**: We don't use an albedo texture for the plastic, because it should be easily customizable. The other maps aren't very important, but *edgeglowplastic* seems to work well.
77+
- **Notes**: There are two materials, *Plastic - Peg Red* and *Metal - Peg*, which need to be renamed to *Plastic* and *Metal* respectively. Only the plastic needs any exported textures, the metal is generic. The plastic however needs a **thickness map** as well.
78+
79+
80+
#### Metal Posts
81+
82+
- **Source**: [`Posts/src~/Metal Posts.blend`](Assets/Library/Posts/src%7E/Metal%20Posts.blend)
83+
- **Reference**: [`/Posts/Metal Posts.blend`](https://github.com/vbousquet/pinball-parts/blob/main/Posts/Metal%20Posts.blend)
84+
- **Asset Folder**: [`Posts/Metal Posts`](Assets/Library/Posts/Metal%20Posts)
85+
- **Export**: Select items in the *Metal Posts* category. Apart from the modifiers, we have a low-poly and hi-poly category that need to be toggled when exporting.
86+
- **Material**: We currently use *Steel Stained* with *Luminosity* of *Steel Base* set to `0.55`.
87+
- **Notes**: There are two materials, *Plastic - Sleeve Yellow* and *Metal - Peg*, which need to be renamed to *Plastic* and *Metal* respectively. Both materials are exported to textures.
88+
89+
90+
#### Metal Hex Spacers
91+
92+
- **Source**: [`Posts/src~/Metal Posts.blend`](Assets/Library/Posts/src%7E/Metal%20Posts.blend)
93+
- **Reference**: [`/Posts/Metal Posts.blend`](https://github.com/vbousquet/pinball-parts/blob/main/Posts/Metal%20Posts.blend)
94+
- **Asset Folder**: [`Posts/Metal Hex Spacers`](Assets/Library/Posts/Metal%20Hex%20Spacers)
95+
- **Export**: Select items in the *Hex Spacers* category. Toggling modifiers is enough.
96+
- **Material**: We currently use *Steel Stained* with *Luminosity* of *Steel Base* set to `0.55`.
97+
- **Notes**: Only one material - straight forward.
98+
99+
100+
#### Metal Round Spacers
101+
102+
- **Source**: [`Posts/src~/Metal Posts.blend`](Assets/Library/Posts/src%7E/Metal%20Posts.blend)
103+
- **Reference**: [`/Posts/Metal Posts.blend`](https://github.com/vbousquet/pinball-parts/blob/main/Posts/Metal%20Posts.blend)
104+
- **Asset Folder**: [`Posts/Metal Round Spacers`](Assets/Library/Posts/Metal%20Hex%20Spacers)
105+
- **Export**: Select items in the *Round Spacers* category. Toggling modifiers is enough.
106+
- **Material**: We currently use *Steel Stained* with *Luminosity* of *Steel Base* set to `0.55`.
107+
- **Notes**: Only one material - straight forward.
108+
64109
## Dependency Graph
65110

66111
Both the HDRP and URP packages have a dependency to this, however the main project maintains its own assets for now.
67112

68113
![image](https://user-images.githubusercontent.com/70426/103706934-feefd880-4fad-11eb-95c3-820ec6738076.png)
69114

70115

116+
## Credits
117+
118+
Most of the assets in this library are derivations of [pinball-parts](https://github.com/vbousquet/pinball-parts). We use the low-poly geometry of these assets, and bake them into normal maps.
119+
71120
## License
72121

73122
[Creative Commons Attribution-ShareAlike 4.0](LICENSE.md)

0 commit comments

Comments
 (0)