ShrinkRay/docs/sr.md

63 lines
2.2 KiB
Markdown

<!-- markdownlint-disable -->
<a href="https://git.utopic.work/PierMesh/ShrinkRay/src/branch/main/src/sr.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
# <kbd>module</kbd> `sr`
---
<a href="https://git.utopic.work/PierMesh/ShrinkRay/src/branch/main/src/sr.py#L9"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `getOutputPath`
```python
getOutputPath(args) list
```
Takes our argParser args, infers and returns the proper output path and what action to take (what function to use)
---
_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._
```
usage: sr [-h] [-o OUTPUTPATH] [-a ANIMATION] [-f OUTPUTFORMAT]
[-i INPUTFORMAT] [-t TRANSPARENT] [-p PALETTES] [-s SCALINGFACTOR]
[-m METADATAFILE] [-e ENCRYPTIONKEY] [-x EXCLUDEALL]
inputPath
positional arguments:
inputPath Path to load input file from
options:
-h, --help show this help message and exit
-o OUTPUTPATH, --outputPath OUTPUTPATH
Output path, if this is set improperly for the output
we will infer the proper path
-a ANIMATION, --animation ANIMATION
Whether this is an animation
-f OUTPUTFORMAT, --outputFormat OUTPUTFORMAT
Format to convert to
-i INPUTFORMAT, --inputFormat INPUTFORMAT
Format to convert from
-t TRANSPARENT, --transparent TRANSPARENT
Whether output should be transparent
-p PALETTES, --palettes PALETTES
Comma seperated list of .hex palettes to create swaps
from
-s SCALINGFACTOR, --scalingFactor SCALINGFACTOR
Scale up this many times when rendering
-m METADATAFILE, --metadataFile METADATAFILE
JSON (.json) or Msgpack (.bin) encoded metadata file
-e ENCRYPTIONKEY, --encryptionKey ENCRYPTIONKEY
Encryption key for image
-x EXCLUDEALL, --excludeAll EXCLUDEALL
Only encrypt metadatas secret field
```