Natural Speech

Give everyone a voice in OldSchool RuneScape! For all characters and players, with over 1000 different voices.

To see a list of features, check out FEATURES.md

Natural Speech requires an installing external tool to process text to generate speech. At the moment the only supported TTS engine is Piper.

Installing Piper on Windows.

1. Download the binary from https://github.com/rhasspy/piper/releases/download/2023.11.14-2/piper_windows_amd64.zip

2. Extract the folder somewhere on your system, for example in C:\piper, so that it is accessible from C:\piper\piper.exe

3. Piper should now be ready to go.

Installing Piper on Mac.

1. Download the binary
   1. For Apple Silicon https://github.com/TheLouisHong/piper/releases/download/2024.2.25/piper_macos_aarch64.tar.gz
   2. For Intel https://github.com/TheLouisHong/piper/releases/download/2024.2.25/piper_macos_x64.tar.gz
2. Download the appropriate package and extract it for example in ~/piper/
3. Piper should be ready to go

Installing Piper on Linux.

1. Find the appropriate version suited for your system from https://github.com/rhasspy/piper/releases/tag/2023.11.14-2
2. Download the appropriate package and extract it for example in ~/piper/
3. Piper should now be ready to go.

Post installation notes

After Installing Piper you should be able to use TTS in-game once the voice pack is downloaded, and the engine has been started.

Setting up Natural Speech

To set up Natural Speech, you will need to install a TTS engine, and download atleast one voice pack through the plugin's panel.

After intalling the plugin, open the panel by clicking the button on the side:

You should see a plugin panel looking like the screenshot below.

Make sure that under the Play and Stop control buttons the location of your piper installation is correct. If it's not, piper will not work. To change it click on the browse button, and navigate to find piper.exe and press Open.

Click Download on a voice pack.

The button will get greyed out, the download will start and might take a while. Be patient.

After it's finished downloading, toggle the repository on.

Piper status should update to Running, which means the plugin is ready to go!