openc2e.pod

   1 =head1 NAME
   2
   3 openc2e - Open source creatures engine
   4
   5 =head1 SYNOPSIS
   6
   7 openc2e [B<-d> I<data path>] [B<-g> I<gametype>] [other arguments...]
   8
   9 =head1 DESCRIPTION
  10
  11 Openc2e is a cross-platform open-source game engine designed to be compatible
  12 with the various game engines of the Creatures artificial-life game series.
  13
  14 =head1 OPTIONS
  15
  16 =over 4
  17
  18 =item B<-h>, B<--help>
  19
  20 Show a brief summary of options
  21
  22 =item B<-V>, B<--version>
  23
  24 Show version string and exit
  25
  26 =item B<-s>, B<--silent>
  27
  28 Disable audio subsystem. It will not be possible to unmute from the UI.
  29
  30 =item B<-k> I<backend>, B<--backend>=I<backend>
  31
  32 Selects the graphics backend. Use B<--help> to get a listing of available
  33 backends.
  34
  35 =item B<-o> I<backend>, B<--audiobackend>=I<backend>
  36
  37 Selects the audio backend. Use B<--help> to get a listing of available
  38 backends.
  39
  40 =item B<-d> I<path>, B<--data-path>=I<path>
  41
  42 Adds a directory to the search path for game data. If none are provided, a
  43 somewhat unhelpful default will be selected.
  44
  45 =item B<-b> I<path>, B<--bootstrap>=I<path>
  46
  47 Adds a directory or file to the list of scripts to be run at world initialization.
  48 If not provided, a default depending on gametype will be selected.
  49
  50 =item B<-g> I<gametype>, B<--gametype>=I<gametype>
  51
  52 Selects the game type to use. (c1, c2, cv, or c3)
  53
  54 =item B<-m> I<gamename>, B<--gamename>=I<gamename>
  55
  56 Sets the game name
  57
  58 =item B<-n>, B<--norun>
  59
  60 Stop running after executing the initial scripts
  61
  62 =item B<-a>, B<--autokill>
  63
  64 Enables autokill
  65
  66 =item B<--autostop>
  67
  68 Enables autostop (disables on CV)
  69
  70 =back
  71
  72 =head1 BUGS
  73
  74 Lots. File some at L<http://code.google.com/p/openc2e/>
  75
  76 =head1 NOTES
  77
  78 You will need a copy of one of the commercial creatures games in order to
  79 use openc2e. Docking station can be downloaded for free from
  80 L<http://www.gamewaredevelopment.co.uk/ds/ds_index.php>.
  81
  82 =head1 AUTHOR
  83
  84 =over 4
  85
  86
  87 =item Alyssa Milburn <fuzzie@fuzzie.org> (fuzzie)
  88
  89 lead developer
  90
  91 =item Bryan Donlan <bdonlan@gmail.com> (bdonlan)
  92
  93 virtual machine and core developer
  94
  95 =item Eric Goodwin <diagonalfish@gmail.com> (muffin)
  96
  97 Windows builds, documentation and bugfixes
  98
  99 =item Jeremy Apthorp <nornagon@gmail.com> (nornagon)
 100
 101 core developer
 102
 103 =item Bertram Bourdrez <bertram@bourdrez.org> (bbz)
 104
 105 misc developer
 106
 107 =item Dylan William Hardison <dylan@haverdev.org> (dylan)
 108
 109 misc developer
 110
 111 =back
 112
 113 =head1 COPYRIGHT AND LICENSE
 114
 115 Copyright 2008 by the above.
 116
 117 This program is free software; you can redistribute it and/or
 118 modify it under the terms of the GNU Lesser General Public
 119 License as published by the Free Software Foundation; either
 120 version 2 of the License, or (at your option) any later version.
 121
 122 =end