https://github.com/ynput/ayon-documentation
Documentation of Ayon
https://github.com/ynput/ayon-documentation
Last synced: about 2 months ago
JSON representation
Documentation of Ayon
- Host: GitHub
- URL: https://github.com/ynput/ayon-documentation
- Owner: ynput
- License: cc-by-sa-4.0
- Created: 2022-12-12T11:27:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-04-10T14:58:43.000Z (about 2 months ago)
- Last Synced: 2026-04-13T07:49:52.343Z (about 2 months ago)
- Language: TypeScript
- Size: 424 MB
- Stars: 11
- Watchers: 8
- Forks: 14
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AYON Developer Portal Official Documentation
AYON Developer Portal is where developers can find documentaiton about AYON development, backend, frontend, launcher desktop app or addons.
:books: View the live [AYON Developer Portal](https://docs.ayon.dev).
:open_book: Need to learn about using AYON as an artist or admin? Visit the [AYON Help Center](https://help.ayon.app/en/help).
:family: Join our community discussions in the [Ynput Forums](https://community.ynput.io).
:phone: Want to know even more about AYON? Get in [Contact](https://ynput.io/contact).
:raising_hand: Need support or want something custom? Explore our [Services](https://ynput.io/services/).
:bulb: Have ideas or requests? Share them on our [Feedback Portal](https://feedback.ayon.app/).
## Contribute
If you spot something incorrect or just think a page could do with some improvement, help us out!
1. Make the changes to the relevant markdown file.
2. Make a PR documenting the changes.
## Running documentation live
- Install Node.js https://nodejs.org/en/download
- `npm install -g yarn`
- `cd {ayon-doc-repo}/website`
- `yarn install`
- `yarn run start`
For additional info, refer to the [Official Docusaurus Documentation](https://docusaurus.io/docs/installation#running-the-development-server).
## Addons
Every addon is resembled by a typescript or JSON file in `src/data/addons/data`.
### Adding new addons
1. duplicate template.ts (or any other addon) in the data folder as a template to get started
2. rename the file to your addon name (e.g. myAddon.ts)
3. fill in the addon data
4. add the preview or logo image in the addons/img folder "myAddon-icon.png" or "myAddon-preview.png"
5. add addon name ("myAddon") to either officialAddons or communityAddons
### File Types
You can use either a .ts (recommended) or .json file
If you use a .ts file you can use intellisense to help you write the file
Take a look at the types.ts file to see what you can add to the addon object
### Using an Icon (recommended)
Icon images should be 1:1 ratio (square) and have a transparent background
When using an icon image, a blurred background will be generated and a color palette will be extracted from the image
### Using a Preview image
Sometimes logo images doesn't work as expected, in that case you can add a preview image that will be used instead
Preview images should be around 1:2 ratio (landscape), include a blurred background and have the text "myAddon Addon" baked into the image.
It's harder to match a preview image to the rest of the addons so it's recommended to use an icon image when possible
| Attribute | Description | Example |
|----------|-------------|---------|
| title | The title of the addon | Blender |
| description | A short description of the addon | Blender is a great addon |
| descriptionLong | A long description of the addon | Blender is a great addon that does a lot of things |
| preview | A preview image of the addon | blender.png |
| icon | A logo image of the addon | blender-icon.png |
| features | An array of features that the addon supports | `['workfiles', 'loader']` |
| families | An array of families that the addon supports | `['image', 'video', 'model']` |
| addons | An array of addons that the addon supports | `['nuke', 'maya']` |
| docs | An object of documentation links for the addon | `{ user: artist_hosts_blender, admin: admin_hosts_blender, developer: dev_publishing }` |
| github | A link to the github code repository of the addon | - |
| discussion | A link to the discussion forum of the addon | - |
| id | The id of the addon, if not set (recommended) it will be the same as the filename | blender |