Skip to content

Latest commit

 

History

History
119 lines (69 loc) · 5.08 KB

README.md

File metadata and controls

119 lines (69 loc) · 5.08 KB
Raw

FlanaSounds

An application to play sounds through the microphone, perfect for discord or any game with voice chat.

Built with

  1. Python - Programming Language.
  2. PySide2 - The official Python module from the Qt for Python project, which provides access to the complete Qt 5.12+ framework.
  3. keyboard - Library to handle the keyboard.
  4. Pydub - Manipulate audio with an simple and easy high level interface. Pydub is integrated into this repository as a fork, it is not included in the requirements.
  5. FFmpeg - A complete, cross-platform solution to record, convert and stream audio and video.

Installation

Windows

1. Install a virtual cable.

Install a virtual cable like https://vb-audio.com/Cable/.

Once you have installed it, go to the windows audio output settings. Be careful, when you install this vb-audio cable, the virtual output is set by default, change it to the one you had before:

windows outputs

Now we need to make the sound of your microphone be heard by that new output:

properties

listen tab settings

listen this device

We are going to use the new audio output as a microphone:

discord audio settings

2. Install FlanaSounds.

You have 2 options.

a) Recommended option:

Download the release and unzip it:

releases

download release

The ffmpeg binaries included in the release are under the lgpl license. See https://ffmpeg.org/legal.html for more information.

b) Clone the repository:

  1. Install Python.
  2. Install Git LFS extension.
  3. Clone the repository. 
    git clone https://github.com/AlberLC/flanasounds.git
  4. Install the pip packages. 
    pip install -r requirements.txt
  5. Install FFmpeg.

Linux

keyboard library needs root on Linux.

  1. Install Python.

  2. Install Git LFS extension.

  3. Clone the repository.

    git clone https://github.com/AlberLC/flanasounds.git

  4. Install the pip packages.

    You might prefer to install keyboard separately via root so you don't have to run the program as root every time.

    pip install -r requirements.txt

  5. Install FFmpeg.

Usage

Run FlanaSounds.exe if you downloaded the release or run main.pyw if you cloned the repository.

Once we see the main screen, the first thing we want to do is choose the folder where the sounds are stored.

Keep in mind that you have to organize the sounds in different subfolders, which FlanaSounds will detect as categories.

folder

The next thing will be to choose the virtual audio output:

outputs

If we activate the checkbox, the sound will be reproduced both by the selected output and by the default output of your operating system. You can adjust the volume of both outputs at the bottom of the interface or by pressing the +/- keys of the numpad.

both outputs

We can choose the key to speak. FlanaSounds will automatically press this key before playing a sound and release it when finished.

keys to talk

Once you have everything ready you can use FlanaSounds. Choose each category by clicking with the mouse or by pressing the normal numeric keys (above qwerty...) and play each sound, within a selected category, with the mouse or by pressing the numeric keys of the numpad. If you want to prevent FlanaSounds from playing sounds you can deselect all categories by pressing escape key.

When a sound is playing, you can pause/resume it by clicking the button below or pressing the 0 key on the numpad.

You can stop all sounds by pressing the button or by pressing the ./supr key of the numpad (period key).

License

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