Metadata-Version: 2.1
Name: smash-tourney
Version: 0.2.0
Summary: The Open Source Super Smash Bros. 1v1 randomizer with customizable "versus" voice implementer!
Home-page: https://github.com/rnegron/smash-tourney
Author: Raúl Negrón
Author-email: raul@raulnegron.me
License: MIT
Description: # smash-tourney
        
        [![Build Status](https://travis-ci.org/rnegron/smash-tourney.svg?branch=master)](https://travis-ci.org/rnegron/smash-tourney) [![Coverage Status](https://coveralls.io/repos/github/rnegron/smash-tourney/badge.svg?branch=master)](https://coveralls.io/github/rnegron/smash-tourney?branch=master)
        ![pypi version](https://img.shields.io/pypi/v/smash-tourney.svg)
        [![Updates](https://pyup.io/repos/github/rnegron/smash-tourney/shield.svg)](https://pyup.io/repos/github/rnegron/smash-tourney/) [![Python 3](https://pyup.io/repos/github/rnegron/smash-tourney/python-3-shield.svg)](https://pyup.io/repos/github/rnegron/smash-tourney/)
        [![Black code style](https://badgen.net/badge/code%20style/black/000)](https://github.com/ambv/black)
        
        ## About
        
        A simple Python script that, given a list of player names, outputs a random pairing of them (representing two players who will fight) and creates .wav files for each pairing. The .wav files contain a text-to-speech reading of the first player's name, followed by a customizable phrase (say, a classic "VERSUS" line?) and ends with the second player's name.
        
        smash-tourney accepts a `versus.wav` file in your working directory. This is used to customize the sound used in the end result. Previously, I had included the file in this repository, but I'm not quite sure I'm allowed to do that. Instead, I'll link to [The Sounds Resource](http://www.sounds-resource.com/), where you can find Smash Bros announcer voice samples. Make sure the file is called `versus.wav` inside your working directory!
        
        ## How to use
        
        _**Intended for use with Python >= 3.6**_.
        
        smash-tourney depends on two external libraries: [pydub](https://github.com/jiaaro/pydub/) to handle audio files and [gTTS](https://github.com/pndurette/gTTS) to interface with Google's text-to-speech API.
        
        You can install smash-tourney using pip!
        
        `$ pip install smash-tourney`
        
        Next, you'll need to create a file with line-separated names for the players who will be participating the the tourney.
        
        You're ready to run the script! Suppose the file with the player names is called `names.txt` in the current directory. Then simply run:
        
        `$ smash-tourney names.txt`
        
        **IMPORTANT**
        
        smash-tourney will create a folder called `tourney` in its working directory, where it will store the created .wav files for convenience.
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
