Home

🙂 Welcome

Welcome to The Whiteout Project Bot wiki! Here there are guides for how to set up the bot locally, or on common hosting services.

🖥️ Prerequisites

Before installing the bot, you need to create a Discord Bot Account. You can do this by following the steps here, and save the bot token somewhere safe for use later in the installation steps.

You can find system requirements for the bot here.

☁️ Hosting Providers

⚠️ This is a self-hosted bot! That means you will need to run the bot somewhere. You could do this on your own PC if you like, but it will stop running if you shut the PC down. Luckily there are some other hosting options available which you can find on our Discord server under the #host-setup channel, many of which are free.

We have a list of known working VPS providers below that you could also check out. Please note that the bot developers are not affiliated with any of these hosting providers (except ikketim) and we do not provider support if your hosting provider has issues.

Provider	URL	Notes
ikketim	https://ikketim.nl/	Free tier, easy setup, recommended and supported by our community. Join https://ikketim.nl/discord for help getting started.
Bot-Hosting	https://bot-hosting.net/	Free tier. Requires earning coins though CAPTCHA / ads to maintain.
Lunes	https://lunes.host/	Free tier with barely enough capacity to run the latest version of the bot. Least recommended host out of the list here.

If you are aware of any additional free providers that can host the bot, please do let us know.

🚀 Installation

The bot can be installed in various different environments, such as locally or in the cloud. Here's a table of guides depending on where you want to install the bot.

Note

Have an old Relo or Patch version? Follow these steps to migrate to the latest version.

Category	Examples	Link
Local	Windows, macOS, Linux	Guide
Docker	Docker Desktop / Compose	Guide

⚠️ Troubleshooting

Head to the Common Issues page, or join our discord server for support.