Metadata-Version: 2.1
Name: no_vtf-desktop
Version: 0.1.3
Summary: Desktop integration for no_vtf (Linux-only)
Home-page: https://git.sr.ht/~b5327157/no_vtf-desktop
Author: b5327157
Author-email: b5327157@protonmail.com
License: GPL-3.0-or-later
Project-URL: Changelog, https://git.sr.ht/~b5327157/no_vtf-desktop/refs
Project-URL: Mailing list, https://lists.sr.ht/~b5327157/no_vtf
Project-URL: Ticket tracker, https://todo.sr.ht/~b5327157/no_vtf
Project-URL: Wiki, https://developer.valvesoftware.com/wiki/no_vtf
Keywords: no_vtf,Source Engine,VTF,Valve Texture Format
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown; variant=CommonMark
License-File: LICENSES/GPL-3.0-or-later.txt
Requires-Dist: click <9,>=8.1.7
Requires-Dist: filelock <4,>=3.13.1
Requires-Dist: imageio <3,>=2.34.0
Requires-Dist: no-vtf <6,>=5.0.0
Requires-Dist: pip
Requires-Dist: pyxdg <1,>=0.28

# no_vtf-desktop

Desktop integration for [no_vtf](https://git.sr.ht/~b5327157/no_vtf) (Linux-only).

![Badge showing supported Python versions](https://img.shields.io/pypi/pyversions/no_vtf-desktop?style=flat-square)
[![Badge showing package version on PyPI](https://img.shields.io/pypi/v/no_vtf-desktop?style=flat-square)](https://pypi.org/project/no-vtf-desktop/)
[![Badge showing number of monthly downloads from PyPI](https://img.shields.io/pypi/dm/no_vtf-desktop?style=flat-square)](https://pypistats.org/packages/no-vtf-desktop)
[![Badge showing package license](https://img.shields.io/pypi/l/no_vtf-desktop?style=flat-square)](https://spdx.org/licenses/GPL-3.0-or-later.html)
[![Badge showing source code repository hosted on SourceHut](https://img.shields.io/badge/sr.ht-repository-white?labelColor=212529&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcKICAgdmlld0JveD0iMCAwIDUxMiA1MTIiCiAgIHZlcnNpb249IjEuMSIKICAgaWQ9InN2ZzUxIgogICBzb2RpcG9kaTpkb2NuYW1lPSJzb3VyY2VodXQtd2hpdGUuc3ZnIgogICBpbmtzY2FwZTp2ZXJzaW9uPSIxLjEgKGM2OGUyMmMzODcsIDIwMjEtMDUtMjMpIgogICB4bWxuczppbmtzY2FwZT0iaHR0cDovL3d3dy5pbmtzY2FwZS5vcmcvbmFtZXNwYWNlcy9pbmtzY2FwZSIKICAgeG1sbnM6c29kaXBvZGk9Imh0dHA6Ly9zb2RpcG9kaS5zb3VyY2Vmb3JnZS5uZXQvRFREL3NvZGlwb2RpLTAuZHRkIgogICB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogIDxkZWZzCiAgICAgaWQ9ImRlZnM1NSIgLz4KICA8c29kaXBvZGk6bmFtZWR2aWV3CiAgICAgaWQ9Im5hbWVkdmlldzUzIgogICAgIHBhZ2Vjb2xvcj0iIzUwNTA1MCIKICAgICBib3JkZXJjb2xvcj0iI2ZmZmZmZiIKICAgICBib3JkZXJvcGFjaXR5PSIxIgogICAgIGlua3NjYXBlOnBhZ2VzaGFkb3c9IjAiCiAgICAgaW5rc2NhcGU6cGFnZW9wYWNpdHk9IjAiCiAgICAgaW5rc2NhcGU6cGFnZWNoZWNrZXJib2FyZD0iMSIKICAgICBzaG93Z3JpZD0iZmFsc2UiCiAgICAgaW5rc2NhcGU6em9vbT0iMS42NTQyOTY5IgogICAgIGlua3NjYXBlOmN4PSIyNTYiCiAgICAgaW5rc2NhcGU6Y3k9IjI1NiIKICAgICBpbmtzY2FwZTp3aW5kb3ctd2lkdGg9IjE5MjAiCiAgICAgaW5rc2NhcGU6d2luZG93LWhlaWdodD0iMTA1OSIKICAgICBpbmtzY2FwZTp3aW5kb3cteD0iMCIKICAgICBpbmtzY2FwZTp3aW5kb3cteT0iMCIKICAgICBpbmtzY2FwZTp3aW5kb3ctbWF4aW1pemVkPSIxIgogICAgIGlua3NjYXBlOmN1cnJlbnQtbGF5ZXI9InN2ZzUxIiAvPgogIDxwYXRoCiAgICAgZD0iTTI1NiA4QzExOSA4IDggMTE5IDggMjU2czExMSAyNDggMjQ4IDI0OCAyNDgtMTExIDI0OC0yNDhTMzkzIDggMjU2IDh6bTAgNDQ4Yy0xMTAuNSAwLTIwMC04OS41LTIwMC0yMDBTMTQ1LjUgNTYgMjU2IDU2czIwMCA4OS41IDIwMCAyMDAtODkuNSAyMDAtMjAwIDIwMHoiCiAgICAgaWQ9InBhdGg0OSIKICAgICBzdHlsZT0iZmlsbDojZmZmZmZmIiAvPgo8L3N2Zz4K)](https://git.sr.ht/~b5327157/no_vtf-desktop)
[![Badge showing builds.sr.ht status](https://builds.sr.ht/~b5327157/no_vtf-desktop/commits.svg)](https://builds.sr.ht/~b5327157/no_vtf-desktop/commits)
[![Badge showing REUSE compliance status](https://api.reuse.software/badge/git.sr.ht/~b5327157/no_vtf-desktop)](https://api.reuse.software/info/git.sr.ht/~b5327157/no_vtf-desktop)
[![Badge showing Nox as the chosen Python automation toolkit](https://img.shields.io/badge/🦊-Nox-D85E00.svg)](https://github.com/wntrblm/nox)

---

⌂ [Project pages](https://sr.ht/~b5327157/no_vtf/sources)
\# [Source code](https://git.sr.ht/~b5327157/no_vtf-desktop/tree)
~ [Changelog](https://git.sr.ht/~b5327157/no_vtf-desktop/refs)
\> [Mailing list](https://lists.sr.ht/~b5327157/no_vtf)
\+ [Ticket tracker](https://todo.sr.ht/~b5327157/no_vtf)
❡ [Wiki](https://developer.valvesoftware.com/wiki/no_vtf)

---

## Features

- application entry (open `.vtf` to convert in-place)
- thumbnailer (preview `.vtf` directly in file manager)

## Requirements

- Python 3.10 or newer
- XDG-compliant desktop environment
- GNOME-compatible thumbnailing system (KDE specifically is not supported)

## Installation

To set up the integration, it is required to execute `no_vtf-desktop` after installing or upgrading the package. Internet connection is required to download the FreeImage library dependency. Re-login might be needed to load the new integration.

As of [PEP 668](https://peps.python.org/pep-0668/), it is recommended to install the package into a virtual environment. Nevertheless, integration of both system-wide installation and user home directory installation is supported too.

### Automated (via [pipx](https://pipx.pypa.io/stable/))

```
pipx install no_vtf-desktop
no_vtf-desktop
```

### Manual

#### Virtual environment

```
python3 -m venv no_vtf-desktop-venv
source no_vtf-desktop-venv/bin/activate
python3 -m pip install no_vtf-desktop
no_vtf-desktop
```

#### User home directory

```
PIP_BREAK_SYSTEM_PACKAGES=1 python3 -m pip install --user no_vtf-desktop
python3 -m no_vtf_desktop
```

#### System-wide

```
sudo PIP_BREAK_SYSTEM_PACKAGES=1 python3 -m pip install no_vtf-desktop
no_vtf-desktop
```

## Uninstallation

```
no_vtf-desktop-uninstall || python3 -m no_vtf_desktop_uninstall
```

## Known issues

### GNOME

Due to thumbnailer sandboxing, GNOME is unable to use ordinary applications installed into the user's home directory for generating thumbnails. Only a system-wide installation will allow the thumbnailer to work properly.

## License

The package is licensed under [GNU GPL v3.0 or later](https://spdx.org/licenses/GPL-3.0-or-later.html).
