League of Legends Announcer

Changes the default League of Legends announcer using Live Client Data API. Note that you need to mute the announcer in-game if you don't want overlapping sound.

Build guide

To build from source. first clone the repository then follow the guide below while in the path of the project
Make sure to install the requirements before proceeding

pip install -r requirements.txt

then use

pip install -e .

and finally run by typing

announcer

or you can build the executable yourself using pyinstaller

pyinstaller cli.py --name "lol-announcer" --add-binary "announcer/sounds:announcer/sounds" --onefile --noconsole

You may need to replace the colon with a semicolon

pyinstaller cli.py --name "lol-announcer" --add-binary "announcer/sounds;announcer/sounds" --onefile --noconsole

Usage

To use just have the program open during a game of League of Legends.
It will automatically identify events in the game and will play the
appropriate sound for the event. You will need to mute the in game
announcer, so that you don't get any overlapping sounds.

Create Sound Packs

The program comes bundled with a few sound packs. If you want to create your own,
You can use the creation tools in the app to generate a pack structure with everything
you need. if you prefer to do this manually, Keep reading for a short tutorial.

Sound Packs need to be placed in the following folders. these change depending
on your platform of choice.
Linux: ~/.config/lol-announcer/sounds/your_sound_pack

Windows: %APPDATA\lol-announcer\sounds\your_sound_pack.

All sounds in a soundpack should be processed. there is an option in app to do this for you.

Each sound pack should contain a config.json with the following data.

{
    "name": "Pack Name",
    "version": "1.0.0",
    "author": "Pack Author",
    "description": "Example Pack Description"
}

Note that the version attribute is optional and not required. it is for internal use only

you can find an example.json file in the root directory of the repository or by clicking here The config.json should be placed with the following directories below
and each one should contain at least one audio file. You may add as many audio files as you
want, a random one will be played during that event.