Home

Welcome to the Iceball project wiki.

This doesn't have a damn thing on it right now. Sorry about that. Damn things will be added where necessary, given enough time and poking of the people who contribute to this thing.

In the meantime, check the docs/ folder in the git repo.

Forking guidelines

If you make a fork of the C code, please follow these guidelines.

• common.version is to remain untouched. That means leave VERSION_W,X,Y,A,Z alone.
• Create a common.fork_*_ver structure. You can use whatever format you like for this, but of course I highly recommend using a table. That * should be some unique name - I suggest using your github name. You can also use a Lua function if you want - it's up to you.
• Don't use the main heartbeat server unless we add official support for your fork - host your own. The heartbeat server is coded in Python 2 and is located in the heart/ directory. The Lua side of the heartbeat code is pkg/base/lib_heartbeat.lua.
• For your heartbeat server, if you change the protocol, use a heartbeat version above 32000.
• Try to maintain backwards compatibility with the base Lua code.