Skip to content
craftd Minecraft Server
Find file
Pull request Compare This branch is 415 commits behind kev009:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
build-aux
compat/sys
extras
htdocs
include
m4
plugins
src
third-party
.gitignore
.gitmodules
AUTHORS
COPYING
Doxyfile
INSTALL
Makefile.am
README
autogen.sh
configure.ac
craftd.conf.dist.in
motd.conf.dist

README

Welcome to craftd!  Up to date documentation lives at:
http://mc.kev009.com/craftd/

Need help?  Want to help?  Come talk!  irc.freenode.net #craftd.

This is early, pre-alpha software.  If you aren't familiar with autotools, 
please wait until binary packages are available.

Dependencies:
libevent 2.0.9+ - http://monkey.org/~provos/libevent/
zlib 1.2.3+ - http://zlib.net/
pthreads

Successfully built on:
Linux - GCC, LLVM/clang
FreeBSD - GCC
IRIX - MIPSpro (Big-Endian functionality verified)
AIX - xlC, GCC (Big-Endian functionality verified)
Windows - MinGW - Needs rework.  Priority is getting basics working on UNIX.
Windows - Cygwin (works great without modification)

== Users ==
Ubuntu users can try to compile from the latest source tarball available from this
server: http://bb.tkte.ch/job/craftd-ubuntu/

Keep in mind that this tarball is generated from the latest source code and it may
not always be stable or usable.

If you need to compile from the git repo, you must run autoreconf -i upon the initial
clone operation or you will not be able to run ./configure.

Once you have the source prepared you can run ./configure, make, and make install.
By default, the server binary is located at /usr/local/bin/craftd.

At the moment craftd does not generate world data for a new server. You will need to
provide world data from another server to start.

== Developers ==
Please contact me and let me know what parts you intend to work on first.

NOTE: You must run autoreconf -i after checking out the git repo to generate a
configure script.

NOTE: You must pull the submodules with: git submodule init && git submodule update

Developer Documentation:
Coding style and architecture notes are on the wiki - 
http://mc.kev009.com/wiki/Craftd:Main_Page

You should have a good understanding of libevent-2.
http://www.wangafu.net/~nickm/libevent-book/
http://mc.kev009.com/libevent - Up to date doxygen

Bundled Libs:
JSON API (used for web GUI and config): 
Jansson (Git head) - http://github.com/akheron/jansson
bstring - Safer C strings - http://bstring.sourceforge.net/

Protocol reference:
http://mc.kev009.com/wiki/

Continuous Integration Builds;
http://bb.tkte.ch/job/craftd-ubuntu/

Also recommended books:
* Advanced Programming in the UNIX Environment - Stevens, et. al
* Programming with POSIX Threads - Butenhof
* UNIX Network Programming, Vol. 1 - Stevens, et. al
* A download of POSIX.1-2008 - http://www.unix.org/2008edition/
Something went wrong with that request. Please try again.