
NAME

  server - run a WolfMUD server instance

SYNOPSIS

  server [DATA_DIR][configuration_file]

DESCRIPTION

  Run a WolfMUD game server. It is strongly advised to create a separate user/
  group for running WolfMUD and that all files are owned by that user/group.
  As a security precaution player and data files should not be accessable to
  normal users on the system.

  server
    The name of the executable, on Windows substitute instances of server with
    server.exe

  DATA_DIR
    Optional relative or absolute path to the data directory. The default
    value is ./data i.e. data in the current path.

  configuration_file
    Optional name of a specific configuration file. The configuration file
    will be looked for in DATA_DIR. The default value is config.wrj

    As a special case NONE may be specified for the configuration file,
    without a DATA_DIR to load the server's default, built in configuration.
    This is only useful for testing.

EXAMPLES

  server
    Run the server using the data directory in the current directory as the
    DATA_DIR and using the default configuration file config.wrj

  server example.wrj
    Run the server using the current directory as the DATA_DIR and using the
    specified configuration file example.wrj

  server /home/diddymus/WolfMUD/data
    Run the server using the directory /home/diddymus/WolfMUD/data as the
    DATA_DIR and using the default configuration file config.wrj

  server /home/diddymus/WolfMUD/data/example.wrj
    Run the server using the directory /home/diddymus/WolfMUD/data as the
    DATA_DIR and using the specified configuration file example.wrj

  server ../src/code.wolfmud.org/WolfMUD.git/data
    Run the server using the relative directory
    ../src/code.wolfmud.org/WolfMUD.git/data as the DATA_DIR and using the
    default configuration file config.wrj

  server NONE
    Run the server using the default, built in configuration. This is only
    useful for testing.

FILES

  DATA_DIR/
    Can be any directory holding WolfMUD data files.

  DATA_DIR/config.wrj
    Default configuration file.

  DATA_DIR/zones/*.wrj
    Directory looked in for zone files. Any files in this directory that end
    in .wrj will be loaded as zone files.

  DATA_DIR/players/*.wrj
    Directory looked in for player account files.

SEE ALSO

  configuration-file.txt, zone-files.txt

BUGS

  Some documented, some yet to be written.

COPYRIGHT

  Copyright 2017 Andrew 'Diddymus' Rolfe. All rights reserved.

  Use of this source code is governed by the license in the LICENSE file
  included with the source code.

