Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 12:54:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update module_kitsu docs

Browse source
This commit is contained in:
Michael 2023-05-03 20:14:33 +03:00 • committed by GitHub
parent d6e7cd638d
commit 925ea3fe93
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

17
website/docs/module_kitsu.md
View file

@ -16,19 +16,22 @@ If you want to connect Kitsu to OpenPype you have to set the `Server` url in Kit
This setting is available for all the users of the OpenPype instance.
## Synchronize
Updating OP with Kitsu data is executed running the `sync-service`, which requires to provide your Kitsu credentials with `-l, --login` and `-p, --password` or by setting the environment variables `KITSU_LOGIN` and `KITSU_PWD`. This process will request data from Kitsu projects with `-proj, --project` and create/delete/update OP assets.
Updating OP with Kitsu data is executed running the `sync-service`, which requires to provide your Kitsu credentials with `-l, --login` and `-p, --password` or by setting the environment variables `KITSU_LOGIN` and `KITSU_PWD`. This process will request data from Kitsu and create/delete/update OP assets.
Once this sync is done, the thread will automatically start a loop to listen to Kitsu events.
The args for `-proj, --project` accept multiple project name, `-proj *` to sync all active projects, and the default value to start a loop to listen to Kitsu events only without any sync.
- `-prj, --project` This flag accepts multiple project name to sync specific projects, and the default to sync all projects.
- `-lo, --listen-only` This flag to run listen to Kitsu events only without any sync.
Note: You must use one argument of `-pro` or `-lo`, because the listen only flag override syncing flag.
```bash
// sync specific projects then run listen
openpype_console module kitsu sync-service -l me@domain.ext -p my_password -proj project_name01 -proj project_name02
// sync all projects then run listen
openpype_console module kitsu sync-service -l me@domain.ext -p my_password -proj *
openpype_console module kitsu sync-service -l me@domain.ext -p my_password
// sync specific projects then run listen
openpype_console module kitsu sync-service -l me@domain.ext -p my_password -prj project_name01 -prj project_name02
// start listen only
openpype_console module kitsu sync-service -l me@domain.ext -p my_password
openpype_console module kitsu sync-service -l me@domain.ext -p my_password -lo
```
### Events listening