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

Added docuumentation

Browse source
This commit is contained in:
Petr Kalis 2023-05-18 17:42:37 +02:00
parent c83bc48b34
commit f6118ed6a8
3 changed files with 42 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
website/docs/admin_settings_system.md
View file

@ -102,6 +102,10 @@ workstation that should be submitting render jobs to muster via OpenPype.
**`templates mapping`** - you can customize Muster templates to match your existing setup here.
### Royal Render
**`Royal Render Root Paths`** - multi platform paths to Royal Render installation.
### Clockify
**`Workspace Name`** - name of the clockify workspace where you would like to be sending all the timelogs.

37
website/docs/module_royalrender.md Normal file
View file

@ -0,0 +1,37 @@
---
id: module_royalrender
title: Royal Render Administration
sidebar_label: Royal Render
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Preparation
For [Royal Render](hhttps://www.royalrender.de/) support you need to set a few things up in both OpenPype and Royal Render itself
1. Deploy OpenPype executable to all nodes of Royal Render farm. See [Install & Run](admin_use.md)
2. Enable Royal Render Module in the [OpenPype Admin Settings](admin_settings_system.md#royal-render).
3. Point OpenPype to your Royal Render installation in the [OpenPype Admin Settings](admin_settings_system.md#royal-render).
4. Install our custom plugin and scripts to your RR repository. It should be as simple as copying content of `openpype/modules/royalrender/rr_root` to `path/to/your/royalrender/repository`.
## Configuration
OpenPype integration for Royal Render consists of pointing RR to location of Openpype executable. That is being done by copying `_install_paths/OpenPype.cfg` to
RR root folder. This file contains reasonable defaults. They could be changed in this file or modified Render apps in `rrControl`.
## Debugging
Current implementation uses dynamically build '.xml' file which is stored in temporary folder accessible by RR. It might make sense to
use this Openpype built file and try to run it via `*__rrServerConsole` executable from command line in case of unforeseeable issues.
## Known issues
Currently environment values set in Openpype are not propagated into render jobs on RR. It is studio responsibility to synchronize environment variables from Openpype with all render nodes for now.