Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
74 lines (54 sloc) 2.65 KB
Welcome to craftd! Up to date documentation lives at:
Need help? Want to help? Come talk! #craftd.
This is early, pre-alpha software. If you aren't familiar with autotools,
please wait until binary packages are available.
libevent 2.0.9+ -
zlib 1.2.3+ -
jansson 2.0+ -
Successfully built on:
Linux - GCC, LLVM/clang
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: or use git to download from
Keep in mind that this is bleeding edge and may not always be stable or usable.
Ruby and Rake are the suggested way of building craftd, although a statically generated
Makefile and configure script are shipped if you cannot/do not want to install Ruby and Rake.
If you need to compile from the git repo, don't forget to run ./
before heading into configuration/compilation.
Once you have the source prepared you can run rake install OR ./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 ./ after checking out the git repo to generate a
configure script and pull the submodules.
Use `git pull` for being up to date. Should you run into build issues, try running
`make distclean` and see if it helps.
Developer Documentation:
Coding style and architecture notes are on the wiki -
You should have a good understanding of libevent-2. - Up to date doxygen
Bundled Libs:
bstring - Safer C strings -
klib - a standalone and lightweight C library
Protocol reference:
Continuous Integration Builds;
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 -