Craftd:Configuration

From wiki.vg
Jump to: navigation, search
Menu

After building and installing craftd, you will need to move the config files into place. craftd looks for the main config file in the following order:

  • ~/.craftd/craftd.conf
  • /etc/craftd/craftd.conf
  • /usr/local/etc/craftd/craftd.conf
  • Current working directory (useful for developers)


By default, these are located in $prefix/etc/craftd/ as *.dist files so as not to overwrite existing configs when you install updates.

cd /usr/local/etc
mv craftd.conf.dist craftd.conf

A config file is necessary, but options may be omitted in which case the defaults will be used. If the file fails to parse, an error message will be logged.

Default configuration file

craftd.conf.dist - Using this configuration file will not change any of the internal default variables.

Available options and their defaults

THIS IS STALE, NEED REWRITE!!

Game Config
Option Default Action Notes
daemonize true Fork the server and run in background N/A
game-bind 0.0.0.0 The IP address to listen on 0.0.0.0 means all available IPs
game-bind6  :: The IPv6 address to listen on  :: means all available IPv6 addresses
game-port 25565 The port players connect to craftd does not run as root; it must be >1024
minecraft-stringmax 100 Players are not allowed to send messages longer than this N/A
motd-file ./motd.conf Text displayed when user logs in N/A
worker-pool-size 2 Number of threads to use for packet processing Set between 1-2x number of CPU cores
world-dir ./world Location of the NBT world save directory N/A
day-rate 20 Game time tick rate during day N/A
sunset-rate 20 Game time tick rate during sunset N/A
night-rate 20 Game time tick rate during night N/A
sunrise-rate 20 Game time tick rate during sunrise N/A
proxy-enabled false Run in proxy mode on port 'game-port' To run both a game server and proxy, run as separate processes on different ports
default-server Default Server The name of the server to connect to when a client logs in and the server is in proxy mode N/A
servers N/A Specifies an array of servers See the server section for default values
Server options
Option Default Action Notes
host 127.0.0.1 The ip address or domain name N/A
name undefined The name for use in configuration files or in-game commands N/A
port 25565 The port of the currently described server N/A
Integrated httpd server
Option Default Action Notes
enabled true Enable the integrated httpd server Used for admin and status
httpd-bind 127.0.0.1 The IP address to listen on localhost only by default
httpd-bind6  ::1 The IPv6 address to listen on  ::1 means only localhost(6)
httpd-port 25566 The port web browsers connect to craftd does not run as root; it must be >1024
static-docroot ./htdocs Location of static web content N/A