kernattila / ayon-documentation Goto Github PK

❗ While we're transitioning from OpenPype, there are a lot of details the are factually incorrect. We're working on resolving all of them. ❗

📚 View the live documentation.

👪 Check out our community discussions forum.

☎️ Want to know even more about AYON? Get in contact.

🙋 Need some support or want something custom? Take a look at our services.

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.

• Install Node.js https://nodejs.org/en/download
• npm install -g yarn
• yarn add docusaurus --dev
• cd {ayon-doc-repo}/website
• yarn start

Every addon is resembled by a typescript or JSON file in src/data/addons/data.

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

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

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

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