README

   1 Voxelands - rewritten in C
   2
   3 What to do with this repo:
   4
   5 clone it
   6 pick some functionality from the current tree
   7 rewrite it in C(89)
   8 commit it here
   9
  10 if something needs a bit of boilerplate, darkrose probably already has it - ask
  11
  12 libs included here already:
  13
  14 array.h - gives dynamic arrays
  15 crypto.h - some some basic hashes, base64, etc
  16 file.h - interact with files as memory buffers, use this to load/read/write/save files, also useful for replacing stream buffers in cpp
  17 list.h - linked list code, any struct with the four prev/next/first/last pointers can use this
  18 nvp.h - name/value pair, basic hash table on top of a linked list, use for config, or to replace cpp std::map
  19 path.h - path resolution, use this to get the path of a file
  20 thread.h - threads and mutexes, can safely lock a mutex twice from the same thread without locking up
  21
  22 common.h - includes some 3D maths, logging, and config functions, as well as some string functions (including cross-arch strdup)
  23         - also has some macros for exposing functions in headers
  24         - and some common/useful structs (vectors, positions, colours, quaternions, rectangles, collision boxes, etc)
  25
  26 SOME TODO:
  27 collision.c is waiting on content*.c/h for getting block data
  28 config.c is waiting on command parsing
  29 log.c is waiting on ui and in-game console
  30 Makefile.mingw-cross/.bsd/other-platform need writting
  31 crypto needs sha1
  32 content can probably start going in, very little graphics support in content features at the moment though
  33 help system in command system needs implementing, also help function should list all commands
  34
  35 COMMANDS:
  36 commands will eventually work the same from the in-game console (prefixed with /), from the system console, in config files, and on the command line when starting the client or server:
  37 so far only config files and command line are implemented.
  38
  39 bind <name> [<modifier>+[...]]<key-or-button>
  40  - bind a key or mouse button, with optional modifiers (ctlr,alt,shift,super)
  41  - to a command or event, <name> must be a single-word command or event
  42  - a key is typically a single character (eg: k,Ä,w), or key-name (eg: space, up)
  43  - a mouse button is one of mouse-left, mouse-centre, mouse-right, scroll-up, scroll-down
  44 alias [name] [command]
  45  - alias a command to another command, helps with keybindings, as multi-word
  46  - commands can be aliased to a single word,
  47  - eg: alias fullscreen set wm.fullscreen true
  48  - if no command is given, will unalias (delete) the <name> command
  49  - if no arguments are given, will list all aliases
  50 set <name> <value>
  51  - set config setting <name> to <value>
  52 get <name>
  53  - prints the value of config setting <name> to console (not yet implemented)
  54 unset <name>
  55  - unset config setting <name>, this restores the default value
  56 exec <file>
  57  - execute the commands in <file>
  58 ignore <file>
  59  - set the ignore flag for <file>, this will prevent a file from being loaded
  60  - such as automatically loaded files (default.cfg) or files loaded from exec in
  61  - other config files
  62  - will also prevent a file from having config saved to it
  63  - note that `exec <file>` removes this flag when used after initial config loading
  64 help [command]
  65  - shows a list of commands, or help for a command (not fully implemented)