Skip to content

Windows Guide (from source)

Setting Up WizBot on Windows from source

  1. Prerequisites

  2. Windows 10 or later (64-bit)

  3. .net 8 sdk
  4. If you want WizBot to play music: Visual C++ 2010 (x86) and Visual C++ 2017 (x64) (both are required, you may install them later)
  5. git - needed to clone the repository (you can also download the zip manually and extract it, but this guide assumes you're using git)
  6. Optional Any code editor, for example Visual Studio Code
    • You'll need to at least modify creds.yml, notepad is inadequate
Installation Instructions

Open PowerShell (press windows button on your keyboard and type powershell, it should show up; alternatively, right click the start menu and select Windows PowerShell), and

  1. Navigate to the location where you want to install the bot
    • for example, type cd ~/Desktop/ and press enter
  2. git clone https://gitlab.com/WizNet/WizBot -b v5 --depth 1
  3. cd wizbot
  4. dotnet publish -c Release -o output/ src/WizBot/
  5. cd output
  6. cp creds_example.yml creds.yml
  7. "You're done installing, you may now proceed to set up your bot's credentials by following the [#creds-guide]
    • Once done, come back here and run the last command
  8. Run the bot dotnet WizBot.dll
  9. 🎉 Enjoy
Update Instructions

Open PowerShell as described above and run the following commands:

  1. Stop the bot
  2. ⚠️ Make sure you don't have your database, credentials or any other wizbot folder open in some application, this might prevent some of the steps from executing succesfully
  3. Navigate to your bot's folder, example:
    • cd ~/Desktop/wizbot
  4. Pull the new version, and make sure you're on the v5 branch
    • ⚠️ If you're on v4, you must run these commands, if not, you may skip them.
      • git remote set-branches origin '*'
      • git fetch -v --depth=1
      • git checkout v5
    • git pull
    • ⚠️ If this fails, you may want to stash or remove your code changes if you don't know how to resolve merge conflicts
  5. Backup old output in case your data is overwritten
    • cp -r -fo output/ output-old
  6. Build the bot again
    • dotnet publish -c Release -o output/ src/WizBot/
  7. Remove old strings and aliases to avoid overwriting the updated versions of those files
    • ⚠ If you've modified said files, back them up instead
    • rm output-old/data/aliases.yml
    • rm -r output-old/data/strings
  8. Copy old data, and new strings
    • cp -Recurse -Force .\output-old\data\ .\output\
    • cp -Recurse -Force src/WizBot/data/strings/ output/data/
  9. Copy creds.yml
    • cp output-old/creds.yml output/
  10. Run the bot
    • cd output
    • dotnet WizBot.dll

🎉 Enjoy

Music prerequisites

In order to use music commands, you need ffmpeg and yt-dlp installed. - ffmpeg-32bit | ffmpeg-64bit - Download the appropriate version for your system (32 bit if you're running a 32 bit OS, or 64 if you're running a 64bit OS). Unzip it, and move ffmpeg.exe to a path that's in your PATH environment variable. If you don't know what that is, just move the ffmpeg.exe file to WizBot/output. - youtube-dlp - Click to download the yt-dlp.exe file, then move yt-dlp.exe to a path that's in your PATH environment variable. If you don't know what that is, just move the yt-dlp.exe file to WizBot/system.