HANDBOOK

   1 ~~~ Developer's Handbook ~~~
   2 * Basic rules
   3 - always discuss your problem with other developers or with maintainer of the appropriate section
   4 - be present on developer's IRC
   5 - try not to break the code in master
   6 - if you do one large thing that surely will break the code, create your own branch
   7 - this Handbook is maintained by xHire - if you want to add or modify something, ask him first!
   8
   9 * Directories
  10 - client/       client code; mainly using SDL
  11 - server/       server code; mustn't use SDL
  12 - base/         code in common for client and server; doesn't use SDL
  13 - widget/       GUI code
  14 - screen/       code for designing each one screen of GUI
  15 - audio/        code that handles audio - sounds and music
  16 - modules/      code of all modules
  17 - net/          code that operates networking
  18
  19 * Filenames
  20 - keep letters small
  21 - if you need more words in a filename, then use this character for separating them: _
  22
  23 * Identificators
  24 - if you need more words in an identificator, then use this character for separating them: _
  25 - don't use global variables
  26
  27 * Translation strings
  28 - keep them clear and following standard scheme
  29 - if a filename is to be mentioned, don't use any quotes and try to situate it to the end of the string
  30
  31 * Code style
  32 - you can use kr.sh script for basic orientation, but think with your head and correct all bull shits
  33 - at the end of each file leave one empty line
  34
  35 * Writing a module
  36
  37 * Creating a package
  38 - let us know and we will tell you everything :c)