Customization#
Overview#
There are a variety of ways to customize the Tokkio UI. One can create multimodal interactions with the avatar, change something about the existing UI, or create a completely custom user experience, and more.
The UI customization guides will walk you through the different customization options available, and provide the relevant documentation for each option.
Customization Options#
See the below table for a summary of all of the customization options available for the UI.
Customization Option |
What It Can Be Used For |
What Is Required To Implement It |
Link To Documentation |
|---|---|---|---|
Update UI parameters |
Change the app title, enable/disable features, and other minor configurations |
Minor changes to the UI configuration YAML file from the ACE Configurator |
|
Show custom multimodal content |
Display custom multimodal content in the UI including images, tables, text, buttons, text input,and more |
Add additional Pipecat frames to the ACE Controller code, no UI code changes are needed |
|
Embed the Tokkio UI in another website as an iframe |
Add a Tokkio UI window to an existing website |
Add a code snippet to the HTML of the existing website |
|
Customize the Tokkio Reference UI |
Change the appearance of components in the Tokkio reference UI, or add new UI features |
Modify the source code of the Tokkio reference UI |
|
Create a new UI from scratch |
Creating a completely custom user experience, or add Tokkio features to an existing website |
Requires a working knowledge of the ACE Controller, VST, and Ingress interfaces, and a significant time investment |