Skip to main content

Valve Texture Format Converter

Project description

no_vtf

Say no to .vtf – convert it to one of the standard image formats.

Badge showing supported Python versions Badge showing package version on PyPI Badge showing number of monthly downloads from PyPI Badge showing source code repository hosted on SourceHut Badge showing builds.sr.ht status Badge showing REUSE compliance status Badge showing compliance with OpenSSF Best Practices Badge showing Nox as the chosen Python automation toolkit

Screencast showing conversion of sprays downloaded in Team Fortress 2 using no_vtf


Project pages # Source code ~ Changelog > Mailing list + Ticket trackerWiki


Highlights

  • cross-platform – runs on any machine where Python is supported
  • console-only – runs without a graphical interface
  • full HDR support (including compressed HDR)
  • parallel conversion – uses all available resources to speed up the process
  • proper decoding of the ARGB8888 format (VTFLib/VTFEdit handles the format incorrectly)
  • formally described .vtf file format (via Kaitai Struct)
  • test suite against crafted .vtf files and reference output
  • desktop environment integration via no_vtf-desktop (Linux-only)

Installation

Application bundle

For Linux and Windows running on x64, there are application bundles with the Python interpreter included. Below are links to the latest version.

Starting from v4.2.0, application bundles GPG-signed with 0x1C3724DFF9CEAF64 are also attached to the tagged versions.

Bundles are ready to be used offline – the FreeImage library is already included.

Package

If you have Python 3.10 or newer, you can install the package from PyPI directly. An optional desktop integration is available via the no_vtf-desktop package.

Before the first conversion, the FreeImage library will be downloaded to support the process. Further conversions are supported offline.

As of PEP 668, it is recommended to install the package into a virtual environment.

Automated installation (via pipx)

pipx install no_vtf

no_vtf ...

Manual installation

python3 -m venv no_vtf-venv

source no_vtf-venv/bin/activate  # Linux
no_vtf-venv/scripts/activate  %= Windows =%

python3 -m pip install no_vtf

no_vtf ...

Usage

General invocation

no_vtf [OPTIONS] [--] PATH...

PATH can be either file or directory. Multiple paths may be provided.

Tip: With bundles, drag-and-drop files or folders to be converted onto the application launcher (the file with icon and no extension on Linux and the .exe file on Windows).

Change output directory

no_vtf --output-dir /tmp PATH...

Override LDR/HDR output format

no_vtf --ldr-format png --hdr-format tiff PATH...

Set FPS for animated textures

no_vtf --animate --fps 20 PATH...

LDR-only VTF2TGA-like conversion

no_vtf --no-animate --ldr-format tga --hdr-format skip PATH...

Further help

no_vtf --help

Supported formats

Input

All textures installed with many Source Engine games, including Team Fortress 2, Source Filmmaker and Portal 2, can be converted with the supported format set.

  • RGBA8888
  • ABGR8888
  • RGB888
  • BGR888
  • I8
  • IA88
  • A8
  • RGB888_BLUESCREEN
  • BGR888_BLUESCREEN
  • ARGB8888
  • BGRA8888
  • DXT1
  • DXT3
  • DXT5
  • BGRA4444
  • DXT1_ONEBITALPHA
  • UV88
  • RGBA16161616F
  • RGBA16161616

All official VTF versions are supported (7.0-7.5).

Output

The following formats were tested and optimized for use:

LDR

  • PNG, APNG
  • TGA
  • TIFF (default)

HDR

  • EXR (default)
  • TIFF

It is also possible to select other formats supported by Imageio.

Known issues

Color space

Color space of LDR textures is inferred from the context in which the texture is used in-game. Since this context is not available when converting the .vtf files directly, color space metadata for the output images cannot be set.

Color space of HDR textures is always linear. It would make sense to set this metadata when converting into the TIFF format, but for technical reasons, this is not done.

Bit-perfect compatibility with VTF2TGA

Some textures (notably those using DXT compression) have up to ±1 difference in R/G/B values compared to the output of VTF2TGA. This might be caused by rounding errors in either implementation.

Animated output

Image frames in the output file might not be stored exactly as they appear in the original .vtf file. For instance, consecutive identical frames might be merged into a single frame with a longer duration.

Benchmark

  • Sample: 11 GiB of LDR .vtf files
  • CPU: Intel Core i7-6500U

Size is the total disk usage consumed by the output. Conversion was done without extraction of all mipmaps.

Compressed PNG, parallel

Time is the wall clock time.

  • 1 worker: 9.71 minutes
  • 2 workers: 5.45 minutes
  • 3 workers: 4.18 minutes
  • 4 workers: 3.77 minutes

Uncompressed, sequential

Time is the total CPU time spent in user and kernel mode.

  • PNG: 10.35 minutes
  • TGA: 2.69 minutes
  • TIFF: 3.27 minutes

In all three cases, the size was 33 GiB.

Compressed, sequential

Time is the total CPU time spent in user and kernel mode.

  • PNG: 5.9 GiB, 12.56 minutes
  • TGA: 14 GiB, 3.77 minutes
  • TIFF: 6.9 GiB, 8.81 minutes

Contributing / Getting help

Please refer to CONTRIBUTING.md.

License

The package is licensed under GNU LGPL v3.0 or later, except of image IO done with the help of the ImageIO FreeImage plugin. This makes the entire package effectively licensed under GNU GPL v3.0 only. If you make use of the image IO part (either directly or indirectly) when linking to no_vtf as a library, the combined work is licensed under the latter license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

no_vtf-5.0.0.tar.gz (1.8 MB view hashes)

Uploaded Source

Built Distribution

no_vtf-5.0.0-py3-none-any.whl (70.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page