AudioPlayer

A simple program for adding sound effects to other programs
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

![Product Name Screen Shot][product-screenshot]

Built With

Python

Getting Started

Start by downloading AudioPlayer.py. You will also need to create a folder in the same directory called _Python_SFX. That's where you will store your .mp3 files.

Prerequisites

In addition to downloading AudioPlayer.py and creating a _Python_SFX folder, you will also need to download your own sound effects files. These should be .mp3 files with descriptive names. Store them in your _Python_SFX folder.

Installation

1. Download AudioPlayer.py

2. Create a folder in the same directory as AudioPlayer.py called _Python_SFX

3. Legally find .mp3 files of your choosing online, or create your own. Store them in your _Python_SFX folder and add their names to AudioPlayer.py

4. That's it! You can now call AudioPlayer in other programs to add sound effects to them!

Usage

While AudioPlayer can be used for any audio in any context, one of the handiest and simplest ways to use it is as an alert. For example, if one is running a loop that checks prices, AudioPlayer could be used as an audio alert if the price variable drops below a certain threshold value.

Example:

...
if price < threshold:
    AudioPlayer.playSound('Navi Hey')
...

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @Fort1Evan - [email protected]

Project Link: https://github.com/EvanGottschalk/AudioPlayer

Acknowledgements

Thinking about contributing to this project? Please do! Your Github username will then appear here.