Installation

To download VoiceTuber you can go through two methods compiling the source or downloading a pre-existing package.

Package Instructions

---

The save format is unstable, any update may break your save, so make small experimental projects.

1. Go to Releases on the Github.

2. Install the ZIP.

Build Instructions

---

Windows

• Clone the source code using GitHub Desktop
  • You can install Github Desktop from: https://desktop.github.com/
• Build Pocketsphinx
  • Install CMake from: https://cmake.org/download/
  • In the cloned project, locate the Pocketsphinx copy at VoiceTuber/3rd-party/pocketsphinx. Run the following commands in cmd:

cmake -S . -B build
cmake --build build
cmake --build build --target install -DCMAKE_INSTALL_PREFIX=bin

• Build libuv
  • Assume CMake is installed from the Pocketsphinx sections
  • In the cloned project, locate the libuv copy at VoiceTuber/3rd-party/libuv. Run the following commands in cmd:

$ mkdir -p build
$ (cd build && cmake .. -DBUILD_TESTING=ON) # generate project with tests
$ cmake --build build                       # add `-j <n>` with cmake >= 3.12

• • This steps will build Debug version of libuv, open generated .sln file from VoiceTuber/3rd-party/libuv/libuv.sln in Visual Studio
  • Switch Solution Configuration to Release
  • Build Solution with Build/Build Solution menu
• Build the rest of the project
  • Open VoiceTuber.sln in Visual Studio 2022
  • Use the menu option Build/Build Solution

Linux

• Install dependencies

sudo apt-get install -y clang pkg-config libsdl2-dev libuv1-dev git cmake

• Clone the app

git clone --recurse-submodules https://github.com/team-pp-studio/VoiceTuber.git

• Build Pocketsphinx

cd VoiceTuber/3rd-party/pocketsphinx
cmake -S . -B build
cmake --build build
cmake --build build --target install
cd ../../..

Last cmake command you may need to run with sudo.

• Clone and compile the build tool coddle

git clone https://github.com/coddle-cpp/coddle.git && cd coddle && ./build.sh

• Install coddle

sudo ./deploy.sh
cd ..

• Build VoiceTuber

cd VoiceTuber && coddle

• Run the application

./VoiceTuber