ayon-core/server_addon
Petr Kalis a557b8b5e3
Wrap: new integration (#5823)
* Added Wrap to applications

* Added icon

* Added wrap to template pre hooks

Needed to copy template as new workfile.
Needed to open Wrap with workfile.
2023-12-05 13:04:32 +01:00
..
aftereffects AYON: Update settings (#5544) 2023-08-31 17:24:52 +02:00
applications/server Wrap: new integration (#5823) 2023-12-05 13:04:32 +01:00
blender/server Changed the labels for layout json extractor 2023-11-30 16:21:11 +01:00
celaction/server AYON: Addon settings in OpenPype (#5347) 2023-07-26 14:08:42 +02:00
clockify/server AYON: Addons creation enhancements (#5356) 2023-07-28 11:51:23 +02:00
core/server use correct label for follow workfile version 2023-11-06 18:28:51 +01:00
deadline/server Merge pull request #5949 from ynput/bugfix/OP-7378-blender-deadline_chunk_size_issue 2023-11-29 12:15:20 +01:00
flame/server AYON: Addon settings in OpenPype (#5347) 2023-07-26 14:08:42 +02:00
fusion/server AYON: Addon settings in OpenPype (#5347) 2023-07-26 14:08:42 +02:00
harmony AYON: Addons creation enhancements (#5356) 2023-07-28 11:51:23 +02:00
hiero/server script menu name change in server addon 2023-11-30 14:22:32 +01:00
houdini/server bump addon versions 2023-11-08 12:38:21 +02:00
kitsu/server AYON: Addons creation enhancements (#5356) 2023-07-28 11:51:23 +02:00
max/server Merge branch 'develop' into enhancement/OP-7072_Validate-Loaded-Plugins 2023-11-15 21:05:25 +08:00
maya bump addon versions 2023-11-08 12:38:21 +02:00
muster/server AYON: Addons creation enhancements (#5356) 2023-07-28 11:51:23 +02:00
nuke/server hound 2023-11-30 14:39:26 +01:00
openpype removed 'shotgun_api3' from openpype dependencies 2023-10-20 15:41:34 +02:00
photoshop Photoshop: Fix removed unsupported Path (#5996) 2023-12-04 18:28:08 +01:00
resolve/server AYON: Addon settings in OpenPype (#5347) 2023-07-26 14:08:42 +02:00
royal_render/server AYON: Addons creation enhancements (#5356) 2023-07-28 11:51:23 +02:00
substancepainter/server Chore: Substance Painter Addons for Ayon (#5914) 2023-11-20 14:30:09 +01:00
timers_manager/server AYON: Addons creation enhancements (#5356) 2023-07-28 11:51:23 +02:00
traypublisher/server ayon settings: trypublisher editorial add task model conversion 2023-11-07 17:28:37 +01:00
tvpaint/server AYON: Addon settings in OpenPype (#5347) 2023-07-26 14:08:42 +02:00
unreal/server AYON: Addon settings in OpenPype (#5347) 2023-07-26 14:08:42 +02:00
create_ayon_addons.py added harmony and flame to skipped addons 2023-11-21 11:07:10 +01:00
README.md AYON: Addon settings in OpenPype (#5347) 2023-07-26 14:08:42 +02:00

Addons for AYON server

Preparation of AYON addons based on OpenPype codebase. The output is a bunch of zip files in ./packages directory that can be uploaded to AYON server. One of the packages is openpype which is OpenPype code converted to AYON addon. The addon is must have requirement to be able to use ayon-launcher. The versioning of openpype addon is following versioning of OpenPype. The other addons contain only settings models.

Intro

OpenPype is transitioning to AYON, a dedicated server with its own database, moving away from MongoDB. During this transition period, OpenPype will remain compatible with both MongoDB and AYON. However, we will gradually update the codebase to align with AYON's data structure and separate individual components into addons.

Currently, OpenPype has an AYON mode, which means it utilizes the AYON server instead of MongoDB through conversion utilities. Initially, we added the AYON executable alongside the OpenPype executables to enable AYON mode. While this approach worked, updating to new code versions would require a complete reinstallation. To address this, we have decided to create a new repository specifically for the base desktop application logic, which we currently refer to as the AYON Launcher. This Launcher will replace the executables generated by the OpenPype build and convert the OpenPype code into a server addon, resulting in smaller updates.

Since the implementation of the AYON Launcher is not yet fully completed, we will maintain both methods of starting AYON mode for now. Once the AYON Launcher is finished, we will remove the AYON executables from the OpenPype codebase entirely.

During this transitional period, the AYON Launcher addon will be a requirement as the entry point for using the AYON Launcher.

How to start

There is a create_ayon_addons.py python file which contains logic how to create server addon from OpenPype codebase. Just run the code.

./.poetry/bin/poetry run python ./server_addon/create_ayon_addons.py

It will create directory ./packages/<addon name>.zip files for AYON server. You can then copy upload the zip files to AYON server. Restart server to update addons information, add the addon version to server bundle and set the bundle for production or staging usage.

Once addon is on server and is enabled, you can just run AYON launcher. Content will be downloaded and used automatically.

Additional arguments

Additional arguments are useful for development purposes.

To skip zip creation to keep only server ready folder structure, pass --skip-zip argument.

./.poetry/bin/poetry run python ./server_addon/create_ayon_addons.py --skip-zip

To create both zips and keep folder structure, pass --keep-sources argument.

./.poetry/bin/poetry run python ./server_addon/create_ayon_addons.py --keep-sources