hlvox 0.20.0

Pieces together voice files to form sentences

HLVox

Originally intended to create sentences from the word snippets for the Half Life 1 Vox, this project can take a folder of word audio files and piece them into sentences. This repo when used standalone (ie by running voice.py directly) will output the sentences as audio files.

Getting Started

To use this project, you will first need a folder full of voice files. If you have Half Life 1 installed, the voices can be extracted from the VPK files using something like GCFScape.

Prerequisites

Python dependencies are managed with uv in this workspace.

An installation of FFMpeg is required. On Ubuntu, just run the following:

apt update
apt install ffmpeg

For persistence, a local sqlite database can be used, or a postgresql database. These are not exposed through the basic CLI.

Installing

How to set up a basic dev environment:

Pull this repo

git pull https://gitlab.com/bhagen/hlvox.git

Change into the new repo directory

cd hlvox

Sync Python dependencies with uv

uv sync

Run commands via uv run from this repo root

uv run --project hlvox python --version

Quick Start

If you want to jump right into generating a sentence, you can point voice.py at a folder of voice audio files!

python hlvox/voice.py --voice-dir ~/my_folder_of_voice_files "the sentence I want to generate"

Your sentence will be exported in the same directory that you ran the file from.

Installing package locally for development

From the repo root:

uv run --project hlvox pip install --editable hlvox

Running the tests

Run tests from the repo root:

uv run --with pytest --with pytest-cov --with coverage --project hlvox --directory hlvox pytest --cov=hlvox ./tests

Documentation Generation

I used Sphinx to create autodoc documentation from docstrings in the modules.

Change into doc directory

cd doc

(If you've modified the source code, grab the new apidocs

sphinx-apidoc -f -o ./source ../hlvox

Generate documentation

make html

Authors

• Blair Hagen - Initial work - bhagen

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Thanks to Valve for making such an amazing voice