KSP-Toolkit/Scripts/README.md

49 lines
1.9 KiB
Markdown
Raw Normal View History

2020-11-03 07:58:36 +00:00
# Scripts
Python scripts for interacting with files
2020-11-03 07:58:36 +00:00
## Installation
All files require python3 to be installed.
2020-11-03 07:58:36 +00:00
`ddscompress`, `ddsdecompress` and `ddsck` require [ImageMagick](https://imagemagick.org/index.php) and [Nvidia Texture Tools](https://github.com/HeliumProject/NvidiaTextureTools) to be installed and available in your `$PATH`.
2020-11-03 07:58:36 +00:00
## Usage
### ddscompress.py
2021-01-20 09:40:09 +00:00
usage: `ddscompress.py [-h] [--convertcmd CMD] [--compresscmd CMD] [files ...]`
2020-11-03 07:58:36 +00:00
Converts any number of files to `.dds` format, automatically choosing dxt1 or dxt5 depending on if the source image has anything in its alpha channel. Designed to be used with a glob, e.g: `ddscompress.py *.png`
2020-11-03 07:58:36 +00:00
2021-01-20 09:43:01 +00:00
###### positional arguments:
2021-01-20 09:42:20 +00:00
* `files`: input texture files
2021-01-20 09:40:09 +00:00
2021-01-20 09:43:01 +00:00
###### optional arguments:
2021-01-20 09:42:20 +00:00
* `-h, --help `: show this help message and exit
* `--convertcmd CMD`: name of imagemagick's convert tool (default: `convert`)
* `--compresscmd CMD`: name of the nvidia dds compress tool (default: `nvcompress`)
2021-01-20 09:40:09 +00:00
### ddsdecompress.py
2021-01-20 09:40:09 +00:00
usage: `ddsdecompress.py [-h] [--decompresscmd CMD] [files ...]`
Converts any number of files to `.tga` from `.dds`. Designed to be used with a glob, e.g: `ddsdecompress.py *.dds`
2021-01-20 09:42:20 +00:00
2021-01-20 09:43:01 +00:00
###### positional arguments:
2021-01-20 09:42:20 +00:00
* `files`: input dds files
2020-11-03 07:58:36 +00:00
2021-01-20 09:43:01 +00:00
###### optional arguments:
2021-01-20 09:42:20 +00:00
* `-h, --help`: show this help message and exit
* `--decompresscmd CMD`: name of the nvidia dds decompress tool (default: `nvdecompress`)
### ddsck.py
2021-01-20 09:40:09 +00:00
usage: `ddsck.py [-h] [--convertcmd CMD] [--infocmd CMD] [files ...]`
Checks any number of dds files for common issues, including formats not supported by KSP, and DXT5 textures that don't use the alpha channel. Designed to be used with a glob, e.g: `ddsck.py *.dds`
2021-01-20 09:43:01 +00:00
###### positional arguments:
2021-01-20 09:42:20 +00:00
* `files`: input dds files
2021-01-20 09:43:01 +00:00
###### optional arguments:
2021-01-20 09:42:20 +00:00
* `-h, --help`: show this help message and exit
* `--convertcmd CMD`: name of imagemagick's convert tool (default: `convert`)
* `--infocmd CMD`: name of the nvidia dds info tool (default: `nvddsinfo`)