Metadata-Version: 2.1
Name: pyspray
Version: 0.0.4
Summary: A CLI interface for quickly making sprays for Team Fortress 2.
Author-email: sillysandvich <teamfortress.stupid@gmail.com>
License: # Gay Agenda License - 1.0
        License originally authored by Nicole Tietz-Sokolskaya <me@ntietz.com>
        
        Copyright (c) 2024 sillysandvich <teamfortress.stupid@gmail.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
          - The above copyright notice and this permission notice shall be included in
            all copies or substantial portions of the Software.
          - The grantee shall actively support rights for all LGBTQ+ people, respecting
            their gender identities.
          - The grantee shall say "be gay, do crime" at least once during use of the
            software.
        
        The license is immediately revoked if the grantee supports restricting the
        rights of LGBTQ+ people.
        
        If the grantee is found to not have said "be gay, do crime" during use of the
        software, the grantee has thirty (30) days to remediate this violation without
        loss of the license. If it is not remediated, then the grantee's grants via
        this license are premanently retracted.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/sillysandvich/pyspray
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi==2024.7.4
Requires-Dist: charset-normalizer==3.3.2
Requires-Dist: click==8.1.7
Requires-Dist: colorama==0.4.6
Requires-Dist: idna==3.7
Requires-Dist: numpy==2.0.1
Requires-Dist: opencv-python==4.10.0.84
Requires-Dist: pillow==10.4.0
Requires-Dist: quicktex==0.2.1
Requires-Dist: requests==2.32.3
Requires-Dist: urllib3==2.2.2

# pyspray
 CLI interface to streamline the process of making TF2 sprays.

## Installation

In order to use `pyspray`, you must have python installed on your system.

`pyspray` can be installed via `pip` with `py -m pip install pyspray` or `python -m pip install pyspray` via the command line, depending on your platform. For simplicity, all commands will be given using `py` (which is the default alias on some Windows systems).

## Usage And CLI Help
`pyspray` should be run as a module using `py -m pyspray <args>`. In order to see a list of available commands, run `py -m pyspray --help`.

To get further information about any of these commands, run `py -m pyspray <command_name> --help`.

## Commands and Basic Usage Examples
Before creating any sprays, `pyspray` needs to know where your `Team Fortress 2` directory is. These files can be found by right clicking on Team Fortress 2 in your Steam games menu, mousing over the `Manage` tab, and then clicking `Browse Local Files`.

Once you have the file path of the `Team Fortress 2` directory, run `py -m pyspray set-directory <file_path>`
#### Static Sprays

A static spray is simply a single image. To create one, run `py -m pyspray static <filepath_or_url_of_image> --name <name_of_spray>`. The name can be omitted, but the autogenerated names are simply the timestamps of creation, and are easy to mix up.

#### Faded Sprays

A faded spray is a spray that changes as you move closer or further away from it. To create a faded spray, run `py -m pyspray fade <url_or_filepath_of_image> <url_or_filepath_of_image>... --name <name_of_spray>`. The images should be listed such that the first image is the one you want shown from furthest away, and the last image is the one you want shown from nearest.

#### Animated Sprays

An animated spray is a spray that moves, and can be made from filetypes like gifs, webms, and mp4s. To create an animated spray, run `py -m pyspray anim <path_or_url_to_animated_file> --name <name_of_spray>`. Note that this works best with short animations, as sprays have a filesize limit of 512 KB. 
