Aquarium addon

[!NOTE] This addon is ready to be used, but keep in mind that it isn't been tested heavily in a production environment. If you have any issue, feel free to reach us or directly open a new issue.

Presentation

Welcome in Aquarium addon for Ayon. 🎉

With this addon, you will be able to connect your projects from Ayon and Aquarium to synchronize your data. You can also create new Aquarium projects, using your existing Ayon projects.

This addon is composed by 3 main parts:

• Client
• Server
  • API
  • Frontend
• Services
  • Leecher
  • Processor

Directory structure

Client

Client code is used in the Ayon Launcher, the AYON pipeline desktop application.

[!WARNING] The client integration is not finished yet.

This client integration allow you to

• Authenticate the user
• Publish media

Server

Python server-side part of the addon. It's mainly used to declare specific addon API endpoints, used by the leecher and processor services to keep your data in sync.

It's also responsible to decalre specific addon settings, in your Ayon server and project settings.

Frontend

This folder is used to provide a web UI in your Ayon settings to pair projects between Ayon and Aquarium and also to trigger a full project sync.

Services

Syncing data between Ayon and Aquarium relies on Ayon services system.

This addon use two components:

• Leecher
  • It's listenning Aquarium's events, and store them into Ayon database for async processing.
• Processor
  • It's looking for specific Aquarium events in Ayon's database and process them to transform data into compatible Ayon's structure and send request to addon server API endpoints to interact with the server.

Installation

This addon is available in Ayon's addon market, or you can clone/download this repository to add it into your Ayon server addon folder.

Development

Looking to develop on this addon ? First of all thanks !

We created a dedicated documentation here.

Maintainers

The repository is co-maintained by Ynput and Fatfish Lab

We welcome new PR, so feel free to open new ones !

License

This project uses the following license: Apache-2.0. See the license file to read it.