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 Git to download and compile

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 a problem
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


IMPORTANT UPGRADE NOTE!

  If you are upgrading from a previous release of WolfMUD it is recommended
  that you rename the current WolfMUD directory, to WolfMUD.old for example.
  This will backup your existing player, zones and configuration files so that
  they can be copied to the new installation after the upgrade. After you have
  downloaded and extracted a binary or source archive — or used Git to clone
  the repository — please read the file upgrading.txt in the docs directory
  for any additional information.

  From v0.0.18 onwards the source, binary and Git clone will all be using the
  WolfMUD directory by default instead of a mix of WolfMUD.git and WolfMUD. In
  addition all executable files will be in the bin directory.


DEPRECATED: GO GET

  The method of using ‘go get’ to retrieve WolfMUD is no longer recommended
  and should be considered deprecated. Depending on the version of Go being
  used it may produce a binary for the server, but the source code and
  supporting data files will be buried somewhere in the module cache.

  It may be possible to use ‘go get’ in GOPATH mode by setting a combination
  of the GOPATH and GO111MODULE environment variables and/or using an old
  version of Go. However, this is no longer officially supported by this
  project.


METHOD [1]: DOWNLOAD BINARY FILES

  The easiest way to obtain WolfMUD and just run it is to download one of the
  binary archives. This method does not even require Go to be installed. It
  will allow you to get a WolfMUD server up and running quickly with a minimum
  amount of fuss. You can use any text editor to modify the sample zone files
  or make new zone files to create your own worlds.

  Once the archive has been extracted, read the file running-the-server.txt in
  the docs directory for details on running the server and connecting to it as
  a player. If you are upgrading please make sure to read upgrading.txt in the
  docs directory.

  To start, download the selected archive to a directory where WOLFMUD will be
  installed. For example, download the WolfMUD-linux-amd64.tgz for 64-bit
  Linux and download the WolfMUD-windows-amd64.zip for 64-bit Windows.

  Extracting the archive will put everything into a WolfMUD directory for you.

  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

  FOR WINDOWS USERS:

    Right click on the saved archive and select ‘extract all’.


METHOD [2]: DOWNLOAD SOURCES & COMPILE

  If you have Go installed but don’t use Git this method is for you.

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

  Instructions for compiling and running the WolfMUD server are included in
  the extracted archive. See compiling-from-source.txt in the docs directory.
  If you are upgrading please make sure to read upgrading.txt in the docs
  directory.

  Extracting the archive will put everything into a WolfMUD directory for you.

  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

  FOR WINDOWS USERS:

    Right click on the saved archive and select ‘extract all’.


METHOD [3]: USING GIT TO DOWNLOAD & COMPILE

  This is how to use a normal Git clone to obtain WolfMUD.

  Instructions for compiling the WolfMUD server are included in the clone. See
  compiling-from-source.txt in the docs directory. If you are upgrading please
  make sure to read upgrading.txt in the docs directory.

  Cloning the repository will put everything into a WolfMUD directory for you.

  FOR LINUX AND WINDOWS USERS:

    Open a terminal or command prompt and change to the directory where you
    want to put WolfMUD. Then issue the following command:

      git clone https://code.wolfmud.org/WolfMUD


  Up to Main Index                          Up to Downloads & Git Repository