Installation
WhackerLink can be installed on both Windows and Linux systems. This guide provides step-by-step instructions for each platform, so you can choose the one that best fits your environment.
Previous experience with self-hosting applications is recommended. If you are unfamiliar with server setup or command-line tools, you may find this process challenging. In that case, consider using a managed hosting service instead of self-hosting WhackerLink.
Prerequisites
Before installing WhackerLink Server, ensure you have:
- A standalone server (VPS or dedicated) running Windows or Linux [Windows Preferred]
- Basic knowledge of command-line tools
- Basic understanding of networking and firewall configuration
WhackerLink is not designed to run on shared hosting or typical game panel hosting environments (such as ZAP-Hosting or Shockbyte). A dedicated or virtual private server (VPS) is required to ensure proper functionality and performance. If you don't have a server, consider using a managed hosting service instead of self-hosting WhackerLink.
- 🪟 Windows
- 🐧 Linux
Windows - Installing the WhackerLink Server Instance
1. Install Dependencies
Before running WhackerLink, ensure the following are installed:
2. Download and unpackage the Server
- Download the latest repository from whackerlink_v4.
- Save the folder to a convenient location (e.g.,
DownloadsorDesktop).
Unzip the downloaded release
- Decompress these files in a convenient location (e.g.,
DownloadsorDesktop). Please note the directory that you export these files to, as we'll use it in the next step.
3. Prepare to Run the Server
Open Command Prompt:
- Press
Win + R, typecmd, and pressEnter.
Navigate to the Server Directory:
Depending on where you downloaded the server:
- Downloads:
cd %USERPROFILE%\Downloads\WhackerLinkServer
- Desktop:
cd %USERPROFILE%\Desktop\WhackerLinkServer
- Other Location:
Replace the path accordingly:
cd path\to\WhackerLinkServer
4. Run the Server
Run the server with the default configuration:
.\WhackerLinkServer.exe -c configs\config.example.yml
Need Help?
Join our Discord community for support, live assistance, and updates.
WhackerLink is a free, open-source project maintained by volunteers. Support is provided as time allows, but response times may vary. Please be patient when seeking assistance.
Linux - Installing the WhackerLink Server Instance
Linux is currently unsupported and broken on the most recent builds of WhackerLink v4. If you are looking to use WLS on Linux, you must use this version: f9b0b7e
1. Install Dependencies
wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb
sudo apt-get update
sudo apt-get install -y dotnet-sdk-8.0 aspnetcore-runtime-8.0 dotnet-runtime-8.0 git
2. Build WhackerLink
git clone https://github.com/whackerlink/whackerlink_v4 --recurse-submodules
cd whackerlink_v4
dotnet build WhackerLinkServer --configuration Linux
dotnet build WhackerLinkBridge --configuration Linux
dotnet build WhackerLink2Dvm --configuration Linux
sudo mkdir ../whackerlink-built
sudo cp WhackerLinkServer/bin/Linux/* ../whackerlink-built/ -r
sudo cp WhackerLink2Dvm/bin/Linux/* ../whackerlink-built/ -r
sudo cp WhackerLinkBridge/bin/Linux/* ../whackerlink-built/ -r
sudo cp WhackerLinkServer/configs/* ../whackerlink-built/configs
sudo cp WhackerLink2Dvm/configs/config.example.yml ../whackerlink-built/configs/whackerlinkdvm-config.yml
sudo cp WhackerLinkBridge/configs/config.example.yml ../whackerlink-built/configs/whackerlinkbridge-config.yml
cd ../whackerlink-built
3. Install the Precompiled Vocoder
mkdir -p /tmp/vocoder_temp && cd /tmp/vocoder_temp
sudo apt install curl
curl -L -O https://github.com/DVMProject/dvmvocoder/releases/download/v0.1/libvocoder-v0.1-linux.tar.gz
tar -xzf libvocoder-v0.1-linux.tar.gz
sudo cp libvocoder.so "$OLDPWD"
cd "$OLDPWD"
rm -rf /tmp/vocoder_temp
4. Compile the Vocoder from Source (If the precompiled causes issues)
cd ..
git clone https://github.com/WhackerLink/dvmvocoder/
cd dvmvocoder
sudo apt install build-essential cmake
mkdir build && cd build
cmake ..
make
sudo cp libvocoder.so ../../whackerlink-built/
cd ../../whackerlink-built
5. Run the Server
sudo ./WhackerLinkServer -c configs/config.example.yml
Need Help?
Join our Discord community for support, live assistance, and updates.
WhackerLink is a free, open-source project maintained by volunteers. Support is provided as time allows, but response times may vary. Please be patient when seeking assistance.