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

modified readme

Browse source
This commit is contained in:
iLLiCiTiT 2020-09-23 17:57:15 +02:00
parent 8cc5a906ff
commit 7c80946cef
1 changed files with 40 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

52
pype/tools/settings/settings/README.md
View file

@ -84,8 +84,8 @@
"type": "list",
"key": "profiles",
"label": "Profiles",
"object_type": "dict-item",
"input_modifiers": {
"object_type": {
"type": "dict-item",
"children": [
{
"key": "families",
@ -199,37 +199,53 @@
- output is list
- items can be added and removed
- items in list must be the same type
- type of items is defined with key `"object_type"` where Pure input name is entered (e.g. `number`)
- because Pure inputs may have modifiers (`number` input has `minimum`, `maximum` and `decimals`) you can set these in key `"input_modifiers"`
- type of items is defined with key `"object_type"`
- there are 2 possible ways how to set the type:
1.) dictionary with item modifiers (`number` input has `minimum`, `maximum` and `decimals`) in that case item type must be set as value of `"type"` (example below)
2.) item type name as string without modifiers (e.g. `text`)
1.) with item modifiers
```
{
"type": "list",
"object_type": "number",
"key": "exclude_ports",
"label": "Exclude ports",
"input_modifiers": {
"minimum": 1,
"maximum": 65535
"object_type": {
"type": "number", # number item type
"minimum": 1, # minimum modifier
"maximum": 65535 # maximum modifier
}
}
```
2.) without modifiers
```
{
"type": "list",
"key": "exclude_ports",
"label": "Exclude ports",
"object_type": "text"
}
```
### dict-modifiable
- one of dictionary inputs, this is only used as value input
- items in this input can be removed and added same way as in `list` input
- value items in dictionary must be the same type
- type of items is defined with key `"object_type"` where Pure input name is entered (e.g. `number`)
- because Pure inputs may have modifiers (`number` input has `minimum`, `maximum` and `decimals`) you can set these in key `"input_modifiers"`
- type of items is defined with key `"object_type"`
- there are 2 possible ways how to set the type:
1.) dictionary with item modifiers (`number` input has `minimum`, `maximum` and `decimals`) in that case item type must be set as value of `"type"` (example below)
2.) item type name as string without modifiers (e.g. `text`)
- this input can be expandable
- that can be set with key `"expandable"` as `True`/`False` (Default: `True`)
- with key `"expanded"` as `True`/`False` can be set that is expanded when GUI is opened (Default: `False`)
1.) with item modifiers
```
{
"type": "dict-modifiable",
"object_type": "number",
"input_modifiers": {
"object_type": {
"type": "number",
"minimum": 0,
"maximum": 300
},
@ -240,6 +256,18 @@
}
```
2.) without modifiers
```
{
"type": "dict-modifiable",
"object_type": "text",
"is_group": true,
"key": "templates_mapping",
"label": "Muster - Templates mapping",
"is_file": true
}
```
### path-widget
- input for paths, use `path-input` internally
- has 2 input modifiers `"multiplatform"` and `"multipath"`