Skip to content

Commit

Permalink
Merge pull request #76 from ynput/chore/remove_subsets_in_concepts
Browse files Browse the repository at this point in the history
  • Loading branch information
mkolar committed Jul 24, 2023
2 parents a6ef82e + b8e54b1 commit bacf0b5
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions website/docs/artist_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,17 @@ AYON has a limitation regarding duplicated names. Name of assets must be unique

Publishing any data from an AYON Folder (a shot, asset build, or any other type) results in a **Product**.

Each product must be of exactly one [type](#product-type), for example, a rig, model, or a look. A single Folder can have many Subsets, even of a single family, named [variants](#variant). By default, a Product is named as a combination of its type + variant. Sometimes prefixed with the task name (often in case of a workfile product).
Each product must be of exactly one [type](#product-type), for example, a rig, model, or a look. A single Folder can have many Products, even of a single family, named [variants](#variant). By default, a Product is named as a combination of its type + variant. Sometimes prefixed with the task name (often in case of a workfile product).

Product type doesn't dictate the file type, but can enforce certain technical specifications. For example, AYON's default configuration expects `model` product type to only contain geometry without any shaders or joints when it is published.

### Variant

Usually, a product needs to be created in multiple *'flavors'*. A character might have multiple different looks, a model needs to be published in different resolutions, a standard animation rig might not be usable in a crowd system, and so on. Variants are here to accommodate all this variety that might be needed within a single asset. A model might have variant: *'main'*, *'proxy'*, *'sculpt'*, while a Subset of *'look'* family could have Subsets *'main'*, *'dirty'*, *'damaged'*. Variants have some default recommendations for their names, but ultimately it's up to the artist to use them for separation of publishes when needed.
Usually, a product needs to be created in multiple *'flavors'*. A character might have multiple different looks, a model needs to be published in different resolutions, a standard animation rig might not be usable in a crowd system, and so on. Variants are here to accommodate all this variety that might be needed within a single asset. A model might have variant: *'main'*, *'proxy'*, *'sculpt'*, while a Product of *'look'* family could have Products *'main'*, *'dirty'*, *'damaged'*. Variants have some default recommendations for their names, but ultimately it's up to the artist to use them for separation of publishes when needed.

### Version

A numbered iteration of a given Subset. Each Version has to contain at least one [representation](#representation).
A numbered iteration of a given Product. Each Version has to contain at least one [representation](#representation).

#### Hero version

Expand All @@ -69,11 +69,11 @@ This is an optional feature. The generation of hero versions can be completely d
The Hero version strategy is also known as a "push" pipeline because the new version of the asset is "pushed" to replace the older version, rather than requiring users to manually "pull" in the latest version.
:::

The use of a hero version strategy can help ensure that everyone is automatically using the latest version of a subset. However, automatically updating would also mean that if a machine was currently rendering a scene for which a new pointcache would be published that mid-render it would get the new updated pointcache resulting in a change of version as frames are being rendered.
The use of a hero version strategy can help ensure that everyone is automatically using the latest version of a product. However, automatically updating would also mean that if a machine was currently rendering a scene for which a new pointcache would be published that mid-render it would get the new updated pointcache resulting in a change of version as frames are being rendered.

### Representation

Each published Subset version can be made up of multiple representations. These represent the actual data on disk as it's extracted from the DCC. These are most often different file formats of the same data, for example, `.ABC` and `.OBJ` representations of a model, but can be a bit more abstract in nature. For example, a video file with a model turnaround is also a representation of a given model version. The only difference is that the data is usable in a video player, rather than a DCC.
Each published Product version can be made up of multiple representations. These represent the actual data on disk as it's extracted from the DCC. These are most often different file formats of the same data, for example, `.ABC` and `.OBJ` representations of a model, but can be a bit more abstract in nature. For example, a video file with a model turnaround is also a representation of a given model version. The only difference is that the data is usable in a video player, rather than a DCC.


### Task
Expand All @@ -85,7 +85,7 @@ Without a task you cannot launch a host application.
:::note
#### Entity naming convention

At this moment, the names of Folders, Tasks, Subsets or Representations can contain only letters, numbers and underscores.
At this moment, the names of Folders, Tasks, Products or Representations can contain only letters, numbers and underscores.
:::

### Workfile
Expand Down Expand Up @@ -114,4 +114,4 @@ A publish instance is a single entry which defines a publish output within a [wo

### Load

Process of importing previously published Subsets into your current scene, using any of the AYON tools. Loading asset using proper tools will ensure that all your scene content stays version controlled and updatable at a later point.
Process of importing previously published Products into your current scene, using any of the AYON tools. Loading asset using proper tools will ensure that all your scene content stays version controlled and updatable at a later point.

0 comments on commit bacf0b5

Please sign in to comment.