Up to Main Index                          Up to Downloads & Git Repository

                               GETTING STARTED

WolfMUD is available in several different ways:

  1. Download a binary and run it
  2. Download sources and compile
  3. Using 'go get' to download and compile
  4. Using 'git' to download and compile


IMPORTANT UPGRADE NOTE!
=======================

If you are upgrading from a previous release of WolfMUD you need to rename the
current WolfMUD directory, for example to WolfMUD.old. This will backup your
existing player, zones and configuration files so that you do not lose them
during the upgrade.


METHOD 1: DOWNLOAD BINARY FILES
===============================

Download one of the binary archives to a directory where you want to install
WolfMUD. For example download WolfMUD-windows-amd64.zip for 64-bit Windows or
WolfMUD-linux-amd64.tgz for 64-bit Linux. Unpacking the archive will create a
WolfMUD directory:


  FOR LINUX USERS:

    In a terminal change to the directory where you saved the archive and run
    the following command making sure to replace WolfMUD-linux-amd64.tgz with
    the name of the archive you downloaded:


      tar -zxvf WolfMUD-linux-amd64.tgz


    Once the archive has been unpacked read the file docs/getting-started.txt
    for details on running the server and connecting to it as a player.

    If you are upgrading please make sure to read docs/upgrading.txt as well.


  FOR WINDOWS USERS:

    Right click on the saved archive and select 'extract all'.

    Once the archive has been unpacked read the file docs\getting-started.txt
    for details on running the server and connecting to it as a player.

    If you are upgrading please make sure to read docs\upgrading.txt as well.


METHOD 2: DOWNLOAD SOURCES & COMPILE
====================================

If you have Go installed but don't use Git or 'go get' this method is for you.

Download one of the source archives to a directory where you want to install
WolfMUD. For example download WolfMUD-source.zip for Windows and download
WolfMUD-source.tgz for Linux.


  FOR LINUX USERS:

    In a terminal change to the directory where you saved the archive and run
    the following command:


      tar -zxvf WolfMUD-source.tgz


    Instructions for compiling and running the WolfMUD server are included in
    the unpacked archive in the following file:

      src/code.wolfmud.org/WolfMUD.git/docs/compiling-from-source.txt


  FOR WINDOWS USERS:

    Right click on the saved archive and select 'extract all'.

    Instructions for compiling and running the WolfMUD server are included in
    the unpacked archive in the following file:

      src\code.wolfmud.org\WolfMUD.git\docs\compiling-from-source.txt

    If you are upgrading please make sure to also read:

      src\code.wolfmud.org\WolfMUD.git\docs\upgrading.txt


METHOD 3: USING GO GET TO DOWNLOAD & COMPILE
============================================

These instructions assume you have Go and Git installed on your machine.
Following the instructions in this section will cause the WolfMUD sources to
be downloaded and compiled for you.

PLEASE NOTE: There may be a long delay when issuing the 'go get' command in
the following instructions. This is due to the WolfMUD git repository being
cloned.


  FOR LINUX USERS:

    These instructions put WolfMUD into a WolfMUD directory in your home
    directory. Open a terminal and issue the following commands:


      cd ~
      mkdir WolfMUD
      cd WolfMUD
      GOPATH=~/WolfMUD go get -u code.wolfmud.org/WolfMUD.git/...


    Instructions for running the WolfMUD server, compiled from source code,
    are included in the unpacked archive. See the following file under the
    section RUNNING (LINUX) for instructions:

      src/code.wolfmud.org/WolfMUD.git/docs/compiling-from-source.txt

    If you are upgrading please make sure to also read:

      src/code.wolfmud.org/WolfMUD.git/docs/upgrading.txt


  FOR WINDOWS USERS:

    These instructions put WolfMUD into a WolfMUD directory at the root of the
    C: drive. First open a command prompt. This can be done by selecting:

       Start -> Windows System -> Command Prompt

    Alternatively press Win+R to open the run dialog. Enter cmd in the open
    field and select the OK button.

    In the command prompt window issue the following commands:


      cd C:\
      mkdir WolfMUD
      cd WolfMUD
      set GOPATH=C:\WolfMUD
      go get -u code.wolfmud.org/WolfMUD.git/...


    Instructions for running the WolfMUD server, compiled from source code,
    are included in the unpacked archive. See the following file under the
    section RUNNING (WINDOWS) for instructions:

      src\code.wolfmud.org\WolfMUD.git\docs/compiling-from-source.txt

    If you are upgrading please make sure to also read:

      src\code.wolfmud.org\WolfMUD.git\docs\upgrading.txt


METHOD 4: USING GIT TO DOWNLOAD & COMPILE
=========================================

Maybe 'go get' does not work for you for some reason. Or you just don't want
to use it. This is how to use a normal Git clone to obtain WolfMUD.


  FOR LINUX USERS:

    These instructions put WolfMUD into a WolfMUD directory in your home
    directory. Open a terminal and issue the following commands:


      cd ~
      mkdir -p ~/WolfMUD/src/code.wolfmud.org/WolfMUD.git
      cd ~/WolfMUD/src/code.wolfmud.org
      git clone https://code.wolfmud.org/WolfMUD WolfMUD.git


    Instructions on compiling and running WolfMUD are included in the
    following file:

      src/code.wolfmud.org/WolfMUD.git/docs/compiling-from-source.txt

    If you are upgrading please make sure to also read:

      src/code.wolfmud.org/WolfMUD.git/docs/upgrading.txt


  FOR WINDOWS USERS:

    These instructions put WolfMUD into a WolfMUD directory at the root of the
    C: drive. First open a command prompt. This can be done by selecting:

       Start -> Windows System -> Command Prompt

    Alternatively press Win+R to open the run dialog. Enter cmd in the open
    field and select the OK button.

    In the command prompt window issue the following commands:


      cd C:\
      mkdir C:\WolfMUD\src\code.wolfmud.org\WolfMUD.git
      cd C:\WolfMUD\src\code.wolfmud.org
      git clone https://code.wolfmud.org/WolfMUD WolfMUD.git


    Instructions on compiling and running WolfMUD are included in the
    following file:

      src\code.wolfmud.org\WolfMUD.git\docs\compiling-from-source.txt

    If you are upgrading please make sure to also read:

      src\code.wolfmud.org\WolfMUD.git\docs\upgrading.txt


______________________________________________________________________________

However you obtain WolfMUD I hope you have fun. If instead you have any issues
please contact me and I'll be happy to try and help you. If you find any
problems with the instructions on this page please contact me and let me know.

Contact details can be found on the contact page here ../../contact.html

--
Diddymus


  Up to Main Index                          Up to Downloads & Git Repository