Custom Gateway - Customer Support

Welcome to the Custom Gateway Support Portal

Here you can raise support tickets and read articles on common queries using the topic sections and search below

2d Avatar Products


Important Note: Avatar products require complex product setup and are advised to be attempted only by users with a thorough understanding of product creation using the Gateway CPP.



Avatars is a feature that allows users to interactively create digital content from a preset range of images/assets, and then apply that content to a 2d product in multiple 'States'. This content will ultimately be printed when the product is ordered.

So for instance, an avatar could be a character, which features on multiple pages of a book, in several different poses. The end user would only have to 'create' the avatar once in a single pose, which would then automatically populate the product with content based on the other predetermined poses. 

Important Note: Avatars is only necessary if multiple 'states' are required based on the assets selected. If the requirement is only a single 'state', then this can be achieved by using standard gallery functionality, and image sync. 


What are the requirements?

1) A Base Product.

This can be a standard Customisable or Personalised product with its own functionality options set. This is the product that any created Avatars can be applied to, once they have been created.

Examples include: Books, Calendars, Cards

2) An Avatar Product.

This is a blank product (using a transparent Aspect), featuring a Print Area per 'State' the avatar can appear in. 

An example avatar may be a small girl, one 'State' may have her standing whilst another 'State' has her sat down.

Each print area then contains an image area for every changeable component or 'Part' in that State.

In the example above, 'Parts' may include: the colour of the girl's hair, the types of clothing the girl is wearing, the girl's facial expression etc etc

3) Image galleries for each 'Part' of each 'State' of the Avatar

The gallery for each part is linked to its corresponding image area.  It's these selections that are used to create the Avatar on screen.


Avatar Product Relationship Diagram in Words


*Image is also uploaded as an attachment at the end of the article

Avatar Product Relationship Diagram in Pictures

*Image is also uploaded as an attachment at the end of the article

Product(s) setup

Example Avatar Product URL

1. Create Your Base Product

In this example, the base product is reflective of a typical book product setup which has a Print Area output for each page of the book, and text personalisation.

2. Create Your Avatar Product
This is the setup of the Avatar product. In this example, it's a male character that has 2 different poses (states).

Important note: The 2d view/aspect should be a transparent png image - this is because all images are to be brought in via galleries.

For each Avatar State you need to specify a Print Area eg:

The next step is to add image areas based on the number of Parts you want the Avatar States to have. This example has 4 Parts per Avatar State.

The end-user should only interact with the initial Avatar State so be sure to Disable User Input for image areas of all other States.

All other States will be populated automatically by the naming convention used for the galleries.

The next step is to create image galleries on CPP for each Part of each Avatar State.

Once that has been done, link the image area for each Part to its relevant gallery, eg:


To synchronise the Parts choice between each Avatar state, the gallery image names need to be the same for each State ie:

Hair 01 (Hair Part Gallery for State A)

Hair 02 (Hair Part Gallery for State B)


Requires the Acp3 app and a custom config with Sync Via Linked Gallery Image Name enabled


3. Apply Your Avatar to Your Base Product

On the base product page there is a section called EXTERNAL SURFACES where it is possible to configure how the Avatar States feature within this book product:

Src Product = Avatar product ID

Src Surface = Avatar State

Dst Surface = Print area to apply the Avatar to in the book (in this context it will usually be a page)

Dst X = X position of the Avatar State

Dst Y = Y position of the Avatar State

Dst Width = Width of the Avatar State (can be used to scale the Avatar)

Dst Height = Height of the Avatar State  (can be used to scale the Avatar)

Important Note: The aspect ratio of the Dst Width and Height should match the aspect ratio of the Avatar State otherwise it will appear as distorted in the book

In this example, we are applying Avatar product 117137, in various Avatar States, to Print Areas on the base product at different locations and scales. If we had multiple Avatars configured, we could increase the number of static designs.



Was this article helpful?
1 out of 1 found this helpful