README.md

SS13 VOX PL

SS13 VOX with polish voices.

Demo:

• https://media.githubusercontent.com/media/ScrewdriverSurvivor/ss13-vox-pl/master/demo-pl.ogg
• https://vocaroo.com/1a118XtBctib

Jak tego używać?

Windows

Jeśli chcemy używać narzędzia na Windows, musimy zainstalować WSL2. Nie będę na razie opisywał jak to zrobić, jest mnóstwo poradników w sieci na ten temat. Po instalacji WSL2 należy zainstalować i uruchomić Ubuntu. Tam wybieramy sobie dowolną nazwę użytkownika i hasło dla konta (i administratora), wówczas można przejść do kolejnej sekcji.

W razie potrzeby dostęp do dysku Ubuntu jest w windowsie dostępny pod udziałem sieciowym \\wsl$\Ubuntu.

Linux

# najpierw aktualizujemy system
sudo apt update
sudo apt upgrade

# dodajemy to do path
export PATH=\"${HOME}/.local/bin:$PATH
echo "export PATH=\"${HOME}/.local/bin:\$PATH\"" >>"${HOME}"/.bashrc

# instalujemy potrzebne narzędzia
sudo apt install python3 python3-pip git

# ściągamy konfigurujemy voxa
git clone https://github.com/ScrewdriverSurvivor/ss13-vox-pl.git
cd ss13-vox
pip3 install buildtools
pip3 install -r requirements.txt

# odpalamy setup zależności
sudo python3 setup.py

Teraz nastąpi ręczne pobranie i instalacja polskich głosów. TODO do zautomatyzowania później

cd /tmp
wget http://www.syntezamowy.pjwstk.edu.pl/korpusowa/pjwstk_ks_multisyn_mbrola.tar.bz2
tar -xf pjwstk_ks_multisyn_mbrola.tar.bz2

# Instalacja mbrola
sudo apt install mbrola mbrola-pl1
sudo cp -r lib/voices/polish /usr/share/festival/voices
sudo cp /tmp/lib/etc/unknown_DebianGNULinux/mbrola /usr/lib/festival/mbrola

# Instalacja multisyna
sudo cp -r /tmp/lib/voices-multisyn/polish /usr/share/festival/voices

# hack na przestarzałe dowiązanie polskiego multisyna
sudo ln -s /usr/share/festival/multisyn/multisyn.scm /usr/share/festival/multisyn.scm
sudo ln -s /usr/share/festival/multisyn/multisyn_pauses.scm /usr/share/festival/multisyn_pauses.scm
sudo ln -s /usr/share/festival/multisyn/target_cost.scm /usr/share/festival/target_cost.scm

Teraz można generować głosy, wynik pojawi się w katalogu dist.

cd ~/ss13-vox-pl
./generate.sh

Pierwotny README.md

TTS-based announcer inspired by Half Life's announcement system.

This project was originally written in 2013 when I was still learning python, so it's a bit rough around the edges. I am slowly trying to improve the code.

Installing

This system has only been tested on Ubuntu. Therefore, this should be installed and run on an Ubuntu system. A VM is recommended, but not necessary.

1. Run sudo apt install python3 && pip install -r requirements.txt to install and configure Python 3 for Ubuntu.
2. Run sudo python3 setup.py to install and configure SoX, Festival, and oggenc.

• NOTE: During the install process, setup.py will download and install packages, and install new Festival voices.

Generating Sounds

/vg/-based Servers

Simply edit wordlists/vg to taste, and run generate.sh.

Everything you need will end up in dist/. Note that old HL VOX sounds like beep, bloop, etc are not included and are expected to be in sound/vox/.

If words come out incorrectly pronounced, add the word to lexicon.txt following the guide at the top of the file. This will generate the required LISP script for you.

TG-based Servers

1. Open config.yml
2. Change codebase to tg so it'll generate the correct code for your server.

You may also wish to duplicate announcements.txt and voxwords.txt and modify them for TG's needs. If you choose to do this, make sure to point to the new files in config.yml.

Changing Voices

You can select which voice to use for each sex in config.yml in the voices: list.

Voice Sexes

Sex	Meaning
default	Non-AI automated announcements, like vox_login.
fem	Feminine voice
mas	Masculine voice

Voice IDs

Each voice requires manual tuning and fuckery in order to work with the standardized echoes and reverbs added later during generation, so not every voice in festival is available here.

ID	Sex	Festival ID	Notes
us-clb	F	nitech_us_clb_arctic_hts	Used by default on /vg/. US female with no accent.
us-rms	M	nitech_us_rms_arctic_hts	Used by default on /vg/. US male with no accent, sounds kinda like DECTalk without post-processing.
us-slt	F	nitech_us_slt_arctic_hts	US female with midwestern accent and flatter voice. Buggy at times: Can drop to a british accent.

Adding to the List

Simply edit the files in wordlist/ according to the following format:

apple
zebra
# Comment bound to wordfile. It'll follow it around when organize.py is run.
wordfile = This is a sample phrase that will be saved to wordfile.ogg

If it's a single letter, add it to the voxwords.txt as a = A.

Testing Phrases

To test a phrase as though it were from in-game, run (replace $SEX with fem or mas):

$ python3 test.py --voice=$SEX sarah connor please report to medbay for johnson inspection

This will call play for you.