New naming convention proposal #149
@ -1,62 +1,117 @@
|
||||
# In-file Prefixes
|
||||
# Datablock names
|
||||
|
||||
::: warning Work in Progress
|
||||
30 Apr. 2023 - The content of this page is currently being edited/updated.
|
||||
:::
|
||||
|
||||
|
|
||||
## Collection names
|
||||
## Separators
|
||||
Simon Thommes
commented
To me these two categories are completely separate from each other. There could also be variations of symmetric objects. I'd propose to use To me these two categories are completely separate from each other. There could also be variations of symmetric objects.
I'd propose to use `.` generally for parts/hierarchies like we have in the past. `.L/R` is compatible with that definition imo.
Variations are for me something orthogonal to that. Could we introduce `:`? Not sure why we are limited to those 3, as compatibility shouldn't be an issue.
Demeter Dzadik
commented
I agree with introducing Only note is that I would still always put I agree with introducing `:` as a separator for variants, I only didn't do this because I wasn't sure if you guys are open to it.
Only note is that I would still always put `.L/.R` at the very end, even if there is a variation, otherwise blender's built-in name flipping function wouldn't work. (Which to be fair isn't used for any built-in operators in Object mode, but for add-ons it's still handy.)
|
||||
We only have 3 separators to work with, so we try to make the most of them and keep their meaning consistent across conventions:
|
||||
`-` : Separates prefixes from each other and from the rest of the name.
|
||||
|
Simon Thommes
commented
I had to google what mnemonic means. Maybe we can move to something more intuitive like identifier? I had to google what mnemonic means. Maybe we can move to something more intuitive like identifier?
Demeter Dzadik
commented
Agreed! Agreed!
|
||||
`_` : Used instead of spacebar in composite words, eg. `eifel_tower_base`.
|
||||
`.` : Suffixes, used only for symmetry sides, ie `.L`/`.R`, and for variations, `clock.normal`, `clock.broken`, `clock.destroyed`
|
||||
|
||||
Andy Goralczyk
commented
The mnemonics should have more 4 letters (more than the 2 and 3) to distinguish them from asset prefixes. otherwise it would be easy to confuse the two. maybe making them lower case would help too. The mnemonics should have more 4 letters (more than the 2 and 3) to distinguish them from asset prefixes. otherwise it would be easy to confuse the two. maybe making them lower case would help too.
Demeter Dzadik
commented
If we don't mind longer ID names, I'm happy to use just a slightly shortened version of names, eg. "elder" for Elder Sprite or "rocket_int" for Rocket Interior. If we don't mind longer ID names, I'm happy to use just a slightly shortened version of names, eg. "elder" for Elder Sprite or "rocket_int" for Rocket Interior.
|
||||
We use prefixes only for top level collections of an asset. This is important to distinguish types of assets. The name of the asset itself should be lowercase.
|
||||
## Asset Mnemonic
|
||||
|
||||
All local datablocks across all assets of a production must have a unique name. To faciliate this, each asset is assigned a mnemonic that must remain unique within a given production. For example, a character named "Elder Sprite" might get the mnemonic "ES". The max length of this mnemonic is not limited, but the shorter the better. If a minor prop in the production is called "Electric Switch", it can not have the mnemonic "ES", because it's already taken. So, "ELSW" would be fine.
|
||||
|
||||
## Asset Collections
|
||||
|
||||
We use prefixes for the root collections of assets to help distinguish different types of assets in the Outliner of a complex shot file. The name of the asset itself should be lowercase.
|
||||
|
||||
- `CH` : Character
|
||||
- `PR` : Prop
|
||||
- `EN` : Environment asset
|
||||
- `SE` : set
|
||||
- `LG` : light rig
|
||||
- `EN` : Environment Prop
|
||||
- `SE` : Set
|
||||
- `LG` : Light Rig
|
||||
- `CAM`: Camera Rig
|
||||
|
||||
Example: `CH-phileas`
|
||||
Example: `CH-elder_sprite`
|
||||
|
||||
Sub-collections should start with the character's name and have dots as separators: `phileas.rig.widgets`
|
||||
Note that there's no technical distinction between different types of assets. This is purely for organizational purposes and comfort.
|
||||
|
Simon Thommes
commented
I don't remember this being a necessity in the current design of the asset pipeline. Maybe I'm misremembering but I don't generally think that binding the tasklayer association with the name is a good idea, since that will make changing this without breakage impossible. I don't remember this being a necessity in the current design of the asset pipeline. Maybe I'm misremembering but I don't generally think that binding the tasklayer association with the name is a good idea, since that will make changing this without breakage impossible.
Demeter Dzadik
commented
It is, it's necessary for each task layer to be assigned its own piece of the hierarchy, otherwise the pipeline doesn't know which hierarchy to keep; The one being pulled in, or the one already in the current file. So when pulling into Rigging currently, it will preserve the current hierarchy for the Rigging collection, but take the hierarchy of the other collections from the publish. It is, it's necessary for each task layer to be assigned its own piece of the hierarchy, otherwise the pipeline doesn't know which hierarchy to keep; The one being pulled in, or the one already in the current file. So when pulling into Rigging currently, it will preserve the current hierarchy for the Rigging collection, but take the hierarchy of the other collections from the publish.
Simon Thommes
commented
But I thought we agreed on storing this data as custom properties and keeping the hierarchies out of it, no? But I thought we agreed on storing this data as custom properties and keeping the hierarchies out of it, no?
Because this isn't just about the exceptions, right? Every collection would have that. Having the tasklayer name in every single collection of an asset seems quite off to me, that's not something I remember considering. Maybe that was a misunderstanding at the time.
Nick Alberelli
commented
So as far as the Asset Pipeline is concerned, we did agree on storing ownership information inside property groups on the individual objects, and that is how ownership of objects is handled by the Asset Pipeline. But for consistency in the organization of collections each task layer has a collection, the user can assign objects to their task layer collection. These top-level collections are named after the task layers and are purely organizational and don't influence who owns what object, but they are necessary to avoid conflicts in collection assignments during Push/Pull. Personally I prefer the collection set-up like this, but I'm open to discussing alternatives. It is possible to replace this feature with some kind of ownership system and UI similar to objects for collections, but that not within the scope of things we are currently focused on. We are more focused on finalizing the transfer logic and getting 'ownership' working on non-object IDs like GeoNode groups. So as far as the Asset Pipeline is concerned, we did agree on storing ownership information inside property groups on the individual objects, and that is how ownership of objects is handled by the Asset Pipeline.
But for consistency in the organization of collections each task layer has a collection, the user can assign objects to their task layer collection. These top-level collections are named after the task layers and are purely organizational and don't influence who owns what object, but they are necessary to avoid conflicts in collection assignments during Push/Pull. Personally I prefer the collection set-up like this, but I'm open to discussing alternatives.
It is possible to replace this feature with some kind of ownership system and UI similar to objects for collections, but that not within the scope of things we are currently focused on. We are more focused on finalizing the transfer logic and getting 'ownership' working on non-object IDs like GeoNode groups.
Demeter Dzadik
commented
It's actually not necessary for the sub-collections' names to include the task layer name, that's true. That was more of a stylistic choice on my end. So you're right, this is in fact legal: I think it might be a bit nicer with the task layer names, when seeing the collections as a flat list, like when appending or using the Blend File view of the Outliner. Also because multiple task layers might have their own collection relating to a given part of a character. But I don't mind too much if this isn't strictly enforced. It's actually not necessary for the sub-collections' names to include the task layer name, that's true. That was more of a stylistic choice on my end. So you're right, this is in fact legal:
```
CH-elder_sprite
esprite-model
esprite-head
esprite-eyes
esprite-eye.L
esprite-eye.R
esprite-rig
esprite-shading
```
I think it might be a bit nicer with the task layer names, when seeing the collections as a flat list, like when appending or using the Blend File view of the Outliner. Also because multiple task layers might have their own collection relating to a given part of a character. But I don't mind too much if this isn't strictly enforced.
|
||||
|
||||
## Object naming
|
||||
The immediate sub-collections of the root collection are strictly defined by our Asset Pipeline add-on, as being `{mnemonic}-{task_layer}`. Task Layers are the different data layers that make up an asset, such as Modeling, Rigging, and Shading. Beyond those two layers, any number of collections may be created according to the needs and wants of the person responsible for a given Task Layer. However, each sub-collection should still start with `{mnemonic}-{task_layer}-`.
|
||||
So, here's what an asset's collection hierarchy might look like:
|
||||
```txt
|
||||
|
Simon Thommes
commented
I find it quite confusing if the main asset collection prefix and any other collection prefix share the exact same formatting. I'd propose to keep those clearly different to avoid confusion and improve readability. So either making the identifier not capitalized or using a different separator or both. I find it quite confusing if the main asset collection prefix and any other collection prefix share the exact same formatting. I'd propose to keep those clearly different to avoid confusion and improve readability.
So either making the identifier not capitalized or using a different separator or both.
Demeter Dzadik
commented
This seems to align with Andy's suggestion of keeping these identifiers longer. In that case, I agree with lower-case, so instead of "ES" or "elder_sprite", we could just have "esprite" or "elder" (up to whoever is first creating the asset). For most assets, especially characters, our names tend to be quite short, so additional shortening isn't always needed. Only downside is that maybe sometimes we'll end up with some pretty long names, but it's not the end of the world. This seems to align with Andy's suggestion of keeping these identifiers longer. In that case, I agree with lower-case, so instead of "ES" or "elder_sprite", we could just have "esprite" or "elder" (up to whoever is first creating the asset). For most assets, especially characters, our names tend to be quite short, so additional shortening isn't always needed. Only downside is that maybe sometimes we'll end up with some pretty long names, but it's not the end of the world.
|
||||
CH-elder_sprite
|
||||
ES-model
|
||||
ES-model-head
|
||||
ES-model-teeth_and_tongue
|
||||
ES-rig
|
||||
ES-rig-widgets
|
||||
ES-rig-helpers
|
||||
ES-rig-eye.L
|
||||
ES-rig-eye.R
|
||||
ES-shading
|
||||
ES-shading-outlines
|
||||
```
|
||||
## Asset Datablocks
|
||||
- All local datablocks (Mesh, Material, Action, etc.) of an asset must start with or at least include the asset's mnemonic, eg `ES-eye.L`. This is automated by the Asset Pipeline add-on.
|
||||
- Object Data and Shape Keys should be named the same as the containing Object. This is automated by the Asset Pipeline add-on.
|
||||
- Object names must not end with a `.00x` suffix. This is enforced by the Asset Pipeline add-on.
|
||||
- In some cases it may be truly unreasonable to expect an artist to give every object in an asset a unique, manually typed in name, like when building a house out of a hundred wooden slab objects. In these cases, the Batch Rename Datablocks built-in add-on should be used to give groups of objects the same name, then in a subsequent step replace the `.` in the `.00x` suffixes with an `_` instead.
|
||||
- The purpose of this is so that, when there are >1 copies of this asset overridden in a file, every object in the same copy of the asset will have the same number suffix. This would not be the case if we didn't replace the `.` with an `_` before publishing the asset.
|
||||
- Without this step, debugging shot files with multiple copies of an asset becomes an absolute nightmare, and if you add the occasional deletion of copies into the mix, it could even confuse Blender's Library Override system and break shots.
|
||||
|
||||
All objects should have a prefix, followed by a dash that determines their type:
|
||||
It is advisable to give Objects an additional prefix to provide information about the object's purpose, especially when it is NOT part of an asset. This is purely for organizational and comfort purposes. Here are some recommendations:
|
||||
|
||||
|
Andy Goralczyk
commented
This needs stronger wording than "should be advisable", every object datablock should have that prefix to make it clear when linking/appending what that object is and to visually distinguish the objects in the outliner and python query. This needs stronger wording than "should be advisable", every object datablock should have that prefix to make it clear when linking/appending what that object is *and* to visually distinguish the objects in the outliner and python query.
Demeter Dzadik
commented
Gotcha, will replace "should" with "must". Gotcha, will replace "should" with "must".
|
||||
- `WGT` : bone shapes
|
||||
- `LGT` : light objects and mesh-lights, also shadow casters
|
||||
- `WGT` : Bone shapes
|
||||
- `LGT` : Light objects and mesh-lights, also shadow casters
|
||||
- `HLP` : Empties and other helper objects that are not rendered
|
||||
- `GEO` : Geometry, meshes, curves that contribute to the rendered appearance of the asset
|
||||
- `RIG` : Rig and rig specific objects that do not appear in rendering
|
||||
- `ENV` : matte paintings, sky-domes, fog volume objects
|
||||
- `GPL` : grease pencil stroke objects (need to differentiate from GEO because can not be rendered on the farm)
|
||||
- `ENV` : Matte paintings, sky-domes, fog volume objects
|
||||
- `GPL` : Grease pencil stroke objects (need to differentiate from GEO because can not be rendered on the farm)
|
||||
|
||||
Use dot uppercase L or R for objects that belong to one side and are mirrored
|
||||
Use `.L` or `.R` for objects that belong to one side and are symmetrical.
|
||||
On the other hand, avoid using `.L` and `.R` when similar objects exist on each side of an asset but aren't meant to be symmetrical.
|
||||
|
||||
Example: `GEO-dresser_drawer.L`
|
||||
Example: `GEO-WRDB-drawer_knob.L` for the left-side drawer knob of a wardrobe prop.
|
||||
|
||||
If a name contains a *of* relationship - in the above example the `drawer` of the `dresser` - these should not be separated by a dot, but rather with an underscore.
|
||||
If a name contains a *of* relationship - in the above example the `knob` of the `drawer` - these should NOT be separated by `.`, but rather with `_`.
|
||||
|
||||
|
Andy Goralczyk
commented
according to the first section, according to the first section, `_` is used only as spacebar replacement, it's not a separator. so an _of_ relationship could be `-` instead
Demeter Dzadik
commented
Thinking about it now, I actually don't think an of relationship needs to be signified by the ID name at all, since it has no technical significance in the pipeline. To me, it's just the same as any other word separation. Collections also help with this. Thinking about it now, I actually don't think an *of* relationship needs to be signified by the ID name at all, since it has no technical significance in the pipeline. To me, it's just the same as any other word separation. Collections also help with this.
|
||||
Another example: `GEO-ellie_watch_screw` and not `GEO-ellie_watch.screw`
|
||||
Another example:
|
||||
```
|
||||
Good: `GEO-ES-watch_screw`
|
||||
Bad: `GEO-ES-watch.screw`
|
||||
```
|
||||
|
||||
If the watch had a variant of type `clean` and `dirty`, these would be using a dot to express the nature of the variant: `GEO-ellie_watch.clean` and `GEO-ellie_watch.dirty`
|
||||
If the watch had a variant of type `clean` and `dirty`, these would be using a `.` to express the nature of the variant:
|
||||
|
Andy Goralczyk
commented
dot dot `.` should become a dash `-`
everything else looks good and can be merged as far as I am concerned :)
Demeter Dzadik
commented
Thanks, fixed! Thanks, fixed!
|
||||
```
|
||||
`GEO-ES-watch.clean`
|
||||
`GEO-ES-watch.dirty`
|
||||
```
|
||||
|
||||
## Actions
|
||||
|
||||
### Prefixes
|
||||
### Pose Library
|
||||
|
||||
Example: `PLB-spring.hand`
|
||||
Pose Library actions are in their own files, and marked as assets, so they show up in the Asset Browser and therefore the built-in Pose Library add-on. Due to frequent use, limited UI space in the Pose Library UI, and the fact that these assets are never duplicated or made local in a shot file (therefore unique naming across the procution isn't important), their names should be kept very simple. No need for any prefix, just simply describe the pose. Since the Pose Library doesn't have collections, use naming to make sure that poses for a given body part get sorted together alphabetically.
|
||||
|
||||
- `PLB` Pose library actions to be linked into animation files
|
||||
- `RIG` Actions used by the rig's Action constraints
|
||||
- `ANI` Animation to be used in a shot
|
||||
|
||||
More examples:
|
||||
|
||||
```txt
|
||||
- ANI-rex.140_0020_A.v001
|
||||
- ANI-ellie.060_scratch.layout.v001
|
||||
- ANI-sprite_A.110_0100_A.v001
|
||||
- PLB-rex_face.scared
|
||||
- PLB-rex_face.happy
|
||||
- PLB-rex_hand.closed
|
||||
Examples:
|
||||
```
|
||||
Hand_Fist
|
||||
Hand_Splayed
|
||||
|
Andy Goralczyk
commented
we established the "no caps, no gaps" rule at some point, should be used here as well. so no uppercase letters except for prefix and suffixes. we established the "no caps, no gaps" rule at some point, should be used here as well. so no uppercase letters except for prefix and suffixes.
|
||||
Face_Happy
|
||||
Face_Surprised
|
||||
Eyes_Blink
|
||||
Eyes_Surprised
|
||||
```
|
||||
|
||||
### Rig Constraints
|
||||
Rigs may use Actions for Action Constraint based control set-ups. Since these are asset datablocks, they must start with the asset mnemonic.
|
||||
Corrective Actions are ones which are meant to activate when two other actions activate. These should use the name of the two trigger actions, separated by a "+".
|
||||
|
||||
Examples:
|
||||
- `RIG-ES-mouth_open`
|
||||
- `RIG-ES-lips_wide`
|
||||
- `RIG-ES-mouth_open+lips_wide`
|
||||
|
||||
### Animations of Shots
|
||||
Actions created for shots should be named `ANI-{asset_mnemonic}-{scene_name}.{version}`
|
||||
|
||||
Examples:
|
||||
```
|
||||
ANI-ES-060_scratch_layout.v001
|
||||
ANI-ES-110_0100_A.v001
|
||||
ANI-REX-140_0020_A.v001
|
||||
```
|
||||
|
||||
I agree with this characterization of
_which to me stands in confilct of the proposal to use it for hierarchies/parts later in this document.I think that later part of the document is over-explaining a bit, and makes things that I see as part of the base name (without any suffixes or prefixes) sound as if they were something technically significant. I'll try to clarify this better.