Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timvanscherpenzeel/texture-compressor
CLI tool for texture compression using ASTC, ETC, PVRTC and S3TC in a KTX container.
https://github.com/timvanscherpenzeel/texture-compressor
android astc cli compression dds desktop dxt5 etc game-development gpu iphone ktx mobile optimisation pvr pvrtc s3tc texture-compression threejs webgl
Last synced: about 1 month ago
JSON representation
CLI tool for texture compression using ASTC, ETC, PVRTC and S3TC in a KTX container.
- Host: GitHub
- URL: https://github.com/timvanscherpenzeel/texture-compressor
- Owner: TimvanScherpenzeel
- License: mit
- Archived: true
- Created: 2017-11-11T08:43:32.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-18T10:36:42.000Z (almost 3 years ago)
- Last Synced: 2024-05-03T03:58:04.387Z (6 months ago)
- Topics: android, astc, cli, compression, dds, desktop, dxt5, etc, game-development, gpu, iphone, ktx, mobile, optimisation, pvr, pvrtc, s3tc, texture-compression, threejs, webgl
- Language: TypeScript
- Homepage:
- Size: 20 MB
- Stars: 195
- Watchers: 7
- Forks: 40
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Texture Compressor
[](https://badge.fury.io/js/texture-compressor)
CLI tool for texture compression using ASTC, ETC, PVRTC and S3TC in a KTX container.
## Installation
Make sure you have [Node.js](http://nodejs.org/) installed.
```sh
$ npm install texture-compressor
```
## Live demo
[Live demo](https://timvanscherpenzeel.github.io/texture-compressor/)
## Documentation
[Supported devices table](docs/SUPPORTED_DEVICES_TABLE.md)
[Supported parameters](docs/SUPPORTED_PARAMETERS.md)
[Recommended parameters](docs/RECOMMENDED_PARAMETERS.md)
## CLI Usage
### ASTC
```sh
$ node ./bin/texture-compressor -i input/example.png -t astc -c ASTC_4x4 -q astcmedium -o output/example-astc.ktx -y -m -vb
```
### ETC
```sh
$ node ./bin/texture-compressor -i input/example.png -t etc -c ETC2_RGB -q etcfast -o output/example-etc.ktx -y -m -vb
```
### PVRTC
```sh
$ node ./bin/texture-compressor -i input/example.png -t pvrtc -c PVRTC1_2 -q pvrtcnormal -o output/example-pvrtc.ktx -y -m -vb
```
### S3TC
```sh
$ node ./bin/texture-compressor -i input/example.png -t s3tc -c DXT1 -q normal -o output/example-s3tc.ktx -y -m -vb
```
## Module usage
```js
const { pack } = require('./dist/cli/lib/index');
pack({
type: 'astc',
input: 'input/example.png',
output: 'output/example-astc.ktx',
compression: 'ASTC_4x4',
quality: 'astcmedium',
verbose: true,
}).then(() => console.log('done!'));
```
## Flags
### Required
-i, --input [example: ./input/example.png] [required]
-o, --output [example: ./output/example.ktx] [required]
-t, --type [example: astc, etc, pvrtc, s3tc] [required]
-c, --compression [example: ASTC_4x4, ETC2_RGB, PVRTC1_2, DXT1] [required]
-q, --quality [example: astcmedium, etcfast, pvrtcnormal, normal] [required]
### Optional
-vb, --verbose [true / false, default: false] [not required]
-rs, --square ['no', '-', '+', default: +] [not required]
-rp, --pot ['no', '-', '+', default: +] [not required]
-m, --mipmap [true / false, default: false] [not required]
-y, --flipY [tue / false, default: false] [not required]
### Tool flags
Tool flags are not processed by `texture-compressor` but rather directly by the binary you are targeting itself.
For example adding `--flags ["usesourceformat DXT1A" "alphaThreshold 200"]` will pass `usesourceformat DXT1A` and `alphaThreshold 200` directly to `Crunch`.
Please be aware that these flags are tool specific and can therefore not be directly applied to the other binaries.
-f, --flags ["flag value" "flag value"] [not required]
To find tool specific flags please refer to the manuals of [ASTC](http://cdn.imgtec.com/sdk-documentation/PVRTexTool.User+Manual.pdf), [ETC](http://cdn.imgtec.com/sdk-documentation/PVRTexTool.User+Manual.pdf), [PVRTC](http://cdn.imgtec.com/sdk-documentation/PVRTexTool.User+Manual.pdf), [S3TC](https://github.com/BinomialLLC/crunch/blob/235946f7a1cf8b9c97e8bf0e8062d5439a51dec7/crunch/crunch.cpp#L70-L181).
## License
My work is released under the [MIT license](https://raw.githubusercontent.com/TimvanScherpenzeel/texture-compressor/master/LICENSE).
This repository distributes multiple binary tools for Windows, Mac and Linux.
This product includes components of the PowerVR™ SDK from Imagination Technologies Limited.
- [astcenc](https://raw.githubusercontent.com/ARM-software/astc-encoder/master/license.txt)
- [PVRTexToolCLI](https://community.imgtec.com/developers/powervr/sdk-end-user-licence-agreement/)
- [crunch](https://raw.githubusercontent.com/BinomialLLC/crunch/master/license.txt)