If you have just learned about us and have no idea where to start, then you have come to the right place as I will be your first guide.
You may have already heard about us but you can also learn the full story from our CEO himself @milan
Ayon is Opensource and you can download it from our github directly!
For ease of deployment, we provide Ayon as a docker container.
Find it here ayon-docker!
You only need to learn two docker commands to get Ayon up and running:
sudo docker compose pull
sudo docker compose up -d
There are also two useful commands for debugging:
- Print the docker server logs:
sudo docker compose logs -t -n 1000 server
- Print the current ayon release info.
sudo docker compose exec server cat RELEASE
The main goals to have a running docker stack as well as download Ayon Launcher on user machines and maybe publish your first asset!
There are many guides that aim to help you achieve these goal.
Feel free to follow the guide that works for you.
- AYON Beta Testing - Minimal step by step guide
- ayon-docker readme | Github
- Quick AYON Deployment on Windows
- Installing Ayon server | AYON Docs
Once you finish Ayon deployment and follow its welcome screen to get essentials packages and addons, you will be able to download Ayon Launcher on artist machines.
For more info: Getting started with AYON | AYON Docs
By this step you should have a running Ayon server and you can find your Ayon launcher in tray.
Why don’t you try to create your first project and try publishing your first asset ?
You can go through Key concepts glossary | AYON Docs
but, let’s emphasize one key concept: Product-Types Vs Representations
Essentially, any product (published data) in ayon consists two piece of information
let say you want to publish a
3d camera and you want to publish it as
product-type here is
camera , the
For newcomers it can turn into a long debate especially if they are used to deal with representations as product types! e.g. A Houdini artist who used to refer to
point cache as just
alembic (I was that Houdini artist ).
For more info check,
- Key concepts glossary | AYON Docs
Key conceptsparts in AYON / Openpype Publish process - Development guide
In Ayon’s core, you will find
pyblish. That explains why Ayon is working in a similar manner to
You can find alot of demos in our docs, e.g.
If you are wondering how to add new
product-types, check this guide AYON / Openpype Publish process - Development guide
By this step, you would like to get your hands dirty and test Ayon as much as you can
- Create projects
- Edit Settings
- Test many DCCs
- Create and publish different product types
You might also start some development, e.g. make a validator optional.
Let say you implemented a new logic and you want to add it to code base as your contribution.
Here you are some guidelines.
- fork the repo you want to contribute to it.
- create new branch
- push your branch into your forked github repo
- Head to the original repo’s
Pull Requeststab and hit
New pull request
gitflow like naming conventions you should use a descriptive name for your branches.
it’s recommended to use the following branch name prefixes:
feature/: when adding new features
enhancement/: when adding enhancements to an existent feature
bugfix/: when fixing a bug
tests/: when making tests
chore/: when doing something chore like moving a function from a library to another.
what if you have a cool idea and you want to share it with us.
Well, Head directly to ideas category Ideas - Ynput community and start sharing!
you can find us on many platforms where you can find many resources to learn from them or ask the developers directly.
In my opinion, It depends on your role whether you are and artist or an admin or a developer.
Actually, our documentation was designed to reflect these roles
So, what could be your next steps ?
- Artist : Learn more about how your DCC integration works and how to use it properly.
- Admin : Learn more about Ayon Administration and how to master Ayon settings.
- Developer : [WIP]