Skip to content

Latest commit

 

History

History
77 lines (67 loc) · 2.66 KB

README_UNIX.md

File metadata and controls

77 lines (67 loc) · 2.66 KB
Raw

Building and Running Fuzzball on Unix

For documentation and general help, see the general README

Building

Tools needed:

  • Make, a C compiler, PCRE library, and friends
  • Optionally, an SSL library, e.g. OpenSSL
  • Optionally, the Git revision control system

For an Ubuntu system, apt-get install these packages

build-essential  # Make tools, compiler
libpcre3-dev     # PCRE headers
libssl-dev       # SSL library headers
git              # Git revision control system
autoconf         # Optional, to re-build configure
automake         # Optional, to re-build makefile
autoconf-archive # Optional, to re-build configure

Get source

  • First time
cd ~          # Or any other desired directory
git clone     https://github.com/fuzzball-muck/fuzzball.git
cd fuzzball
  • To update
cd ~/fuzzball  # Same path as above, plus the 'fuzzball' directory
git pull

Configure

If you need to rebuild the configuration file (Because you have edited configure.in), you can use the following command:

autoreconf

This is not typically needed. You can then continue to run configure thusly:

./configure --with-ssl # Or choose your own options
  • See ./configure --help
    • If needed, specify SSL headers via --with-ssl=/path/to/dir, or PCRE headers via --with-pcre=/path/to/dir
  • When testing, use a different --prefix, e.g. ./configure --prefix="$HOME/fuzzball-test"
  • If using TLS, cat your certificate fullchain.pem and key privkey.pem into game/data/server.pem, or later configure @tune ssl_cert_file and @tune ssl_key_file

Build

make clean && make
make install
make install-sysv-inits  # Skip to not run at startup

Running

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

Quick-start

  • Follow the build directions above
  • Copy the relevant databases (alternatively, use fuzzball/scripts/fbmuck-add)
FB_DIR="$(pwd)"   # Directory containing Fuzzball
PREFIX="."        # If installing to a different prefix, set it here
cp -r "$FB_DIR/game/."          "$PREFIX/game"                       # Copy game information
cp -r "$FB_DIR/dbs/starterdb/." "$PREFIX/game"                       # Copy database
mv "$PREFIX/game/data/starterdb.db" "$PREFIX/game/data/std-db.db"    # Rename database to standard
  • Start Fuzzball
/usr/local/sbin/fb-restart
# If using a custom prefix, $PREFIX/sbin/fb-restart