Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme file #3

Merged
merged 2 commits into from
May 27, 2024
Merged

update readme file #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3952c5
:memo: update readme file
antirotor May 21, 2024
873985f
Merge branch 'develop' into documentation/update-readme
antirotor May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,25 @@ Goal of this addon is to help distribute USD binaries:
- USD AR2 plugin for __some__ supported DCCs.
- USD Tools (usdcat, usdedit, usdinfo, usdview, usdzip) coming with USD build.
- Standalone tools for AYON - USD interoperation.

## Getting Started

### Installation

1. Clone the repository to your local machine.
2. Run `.\tools\manage.ps1 create-env` on Windows or `./tools/manage.sh create-env` on Linux.
3. Run `.\tools\manage.ps1 build` on Windows or `./tools/manage.sh build` on Linux.
4. In AYON, go to `Studio Settings` -> `Bundles` -> `Install Addons...` and select the `./package/ayon_usd-x.x.x.zip` file.
5. Upload the Addon and let the server restart after installation is done.
6. Use new addon in your bundles.

### Configuration

In addon settings, you can configure mapping between USD Resolver plugin and you DCCs.
`App Name` is the name of the DCC application, like `maya/2025` corresponding
to the Application addon settings. Then there is a platform settings, where you
can specify the platform for which the USD Asset Resolver plugin is used.
Lastly, there is a URL to the USD Asset Resolver plugin zip matching the platform and
the DCC application.

`ayon+settings://ayon_usd/asset_resolvers` is the key for the settings.