README_WINDOWS.md

Building and Running Fuzzball on Windows

For documentation and general help, see the general README

Running

• Install the 32-bit Visual C++ Redistributable for Visual Studio 2019 (Fuzzball currently does not support 64-bit)
  • Pick the x86 version, or just use this direct link to vc_redist.x86.exe
• Manage the server with restart.exe

For a comprehensive guide to running a MUCK, check out MINK - The Muck Information Kiosk.

Quick-start

• Follow the build directions, or download a pre-built package
• Set up configuration in restart.ini

cd "path\to\fuzzball\folder"
restart -c

• Edit and save restart.ini with your options, e.g. with notepad restart.ini
• If using SSL, save your certificate and key as data\server.pem, or later configure @tune ssl_cert_file and @tune ssl_key_file
• Start the server

restart

Building

Tools needed:

• Visual Studio 2015 or higher
• Conan.io package manager, or a manually installed SSL library, e.g. OpenSSL for Windows
• Optionally, the Git revision control system

Get source

• First time
  • Open a Git Bash shell in the desired folder (if Windows Explorer integration is active, right-click, Git Bash)

cd ~          # Or any other desired directory
git clone     https://github.com/fuzzball-muck/fuzzball.git
cd fuzzball

• To update
  • Open a Git Bash shell

cd ~/fuzzball  # Same path as above, plus the 'fuzzball' directory
git pull

• Or download a zip archive from Github

Configure

Use the Windows command prompt instead of Git Bash

• Set up Visual Studio environment variables
  • Use Program Files instead of Program Files (x86) if on a 32-bit machine
  • Fuzzball does not currently support compiling as 64-bit

"C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x86

• Set up dependencies with Conan.io

conan install -s arch=x86
set OPENSSLDIR=C:\path\to\fuzzball\bin

• Or, use a manually-installed version of OpenSSL

set OPENSSLDIR=C:\path\to\openssl

Build

nmake /f makefile.win