Ayon dev mode was introduced to ease pipeline client code development, however it sill has some limitations, More about that later.
Ayon dev enables users to:
- change addons versions within the dev bundle
- have explicit addon paths
- make it available for particular users
Here is how to setup Ayon dev mode.
Follow the following steps
Enable developer mode for particular users.
Create Dev Bundles
Select your dev bundle, to start editing its settings
Caution: Don’t forget to set your Dev Bundle settings!
Hint: you may copy settings from other bundles as follows:
This is possible by running Ayon launcher live from Ayon launcher Repo
I’m on windows.
In power shell
git clone https://github.com/ynput/ayon-launcher.git
From your Ayon Launcher directory, run :
Windows: use either one of these:
.\tools\manage.ps1 run --use-dev
Linux & macOS:
./tools/make.sh run --use-dev
By this step, you are able to:
- Run Ayon Launcher in Dev mode.
- Create dev bundle.
- Change addons versions in your dev bundle as desired.
As mentioned earlier, Ayon dev mode was introduced to ease pipeline client code development.
And, in dev bundle settings we expose addons’ client code path which is mostly the path of addons repo clones on your disk.
Let’s test that and understand the limitations.
You need to set
core addon path to your
ayon-core repo path.
P.S. You should create
core addon zip file and upload to ayon server and then select that version in bundle settings.
Addons that are not yet separated from
Their code is already part of
coreso they are updated whenever you update
However their settings not. So, you are still required to upload their addon zip files to update their settings on the server.
Note: They are always using defaults (defined in
server_addondir) as base if their addon version are set to
Nonein Bundle settings.
If you have OpenPype addon, you’ll need to set its version to
For those addons, you are still required to upload their addon zip files to update their settings and server side code.
e.g. Kitsu Addon
I need to upload its addon zip file in order to find it in the version drop down menu
I can point to my unzipped addon client code on my side.
This step provides more info about creating Addon files.
We use the following commands to create addon files.
ayon-core repo directory:
To export core addon:
--output is optional
python create_package.py --output <my-favorite-dir>
To export other addons:
--addon are optional
python server_addon\create_ayon_addons.py --output <my-favorite-dir> --addon houdini
For Addons that have their own Repos:
In their Repos directories.
Some addons like kitsu have client and server specific code for them I’m using
python create_package.py --skip-zip --only-client --output <my-favorite-dir-for-client-code>
python create_package.py --output <my-favorite-dir-for-addon-zip-file>
By this step, you are able to work on addons’ code locally on your machine.
Once you are happy and comfortable with your new addons code, It’s time to upload them to users.
This is done by uploading the addon zip, which might have done while working with your addon.
But a rule of thumb, delete it from the server as settings might conflict.
e.g. If I’m working with
core-0.2.1-dev.1from my ayon server.
core-0.2.1-dev.1zip from the ayon core clone on my disk
- Upload it to server
- Create new addon (with dev disabled) and set the new addon version.
Ayon server wont allow addon installation if it’s used in any bundles (even if they were dev bundles)
So, you may need to set the version to
Nonein your dev bundle.
you can define different “configurations” in your IDE to create packages automatically.
you can use live Ayon launcher with deadline as mentioned in AYON / Openpype Deadline Setup by using the
ayon_console.bat, it’s in tools folder inside Ayon Launcher Repo.
But, it doesn’t support dev mode yet.
In other words: your published job will only work in production mode which can’t access your dev bundle.