-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from ynput/enhancement/core-addon-readme
Addon README
- Loading branch information
Showing
1 changed file
with
18 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,20 @@ | ||
|
||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
[![All Contributors](https://img.shields.io/badge/all_contributors-28-orange.svg?style=flat-square)](#contributors-) | ||
<!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
AYON-core | ||
AYON Core addon | ||
======== | ||
|
||
AYON core provides the base building blocks for all other AYON addons and integrations and is responsible for discovery and initialization of other addons. | ||
|
||
- Some of its key functions include: | ||
- It is used as the main command line handler in [ayon-launcher](https://github.com/ynput/ayon-launcher) application. | ||
- Provides publishing plugins that are available to all AYON integrations. | ||
- Defines the base classes for new pipeline integrations | ||
- Provides global hooks | ||
- Provides universally available loaders and launcher actions | ||
- Defines pipeline API used by other integrations | ||
- Provides all graphical tools for artists | ||
- Defines AYON QT styling | ||
- A bunch more things | ||
|
||
Together with [ayon-launcher](https://github.com/ynput/ayon-launcher) , they form the base of AYON pipeline and is one of few compulsory addons for AYON pipeline to be useful in a meaningful way. | ||
|
||
AYON-core is a successor to OpenPype repository (minus all the addons) and still in the process of cleaning up of all references. Please bear with us during this transitional phase. |