README

   1 OpenBOR (anallyst edition)\r
   2 --------------------------\r
   3 \r
   4 BUILD\r
   5 =====\r
   6 just run:\r
   7 \r
   8 make\r
   9 \r
  10 an executable of the name "OpenBOR" will be created.\r
  11 \r
  12 possible flags to make:\r
  13 \r
  14 NO_GL=1 BUILD_DEBUG=1 make #will build without opengl but with debugging support\r
  15 \r
  16 OpenBOR directory layout:\r
  17       -> OpenBOR       (executable)\r
  18       -> Paks/         (put paks or directories with extracted paks)\r
  19       -> ScreenShots/\r
  20       -> Logs/\r
  21       -> Saves/\r
  22 \r
  23 ABOUT\r
  24 =====\r
  25 \r
  26 OpenBOR is a continuation of the Beats Of Rage 2D game engine, which was originally\r
  27 created by http://www.senileteam.com.\r
  28 \r
  29 this is a fork of "official OpenBOR" (i.e. from lavalit forums) \r
  30 by rofl0r aka anallyst, former "OpenBOR team" member.\r
  31 \r
  32 his work on OpenBOR started back with (~ SVN rev 2900+).\r
  33 he left the lavalit team due to internal differences at around SVN rev 3316 and \r
  34 started his own fork.\r
  35 \r
  36 instead of adding features over features, it is the intent to strip off unnecesary\r
  37 stuff and simplify things, while staying compatible to the existing mods and POSIX.\r
  38 \r
  39 this is a huge task, since OpenBOR source is really badly designed \r
  40 (as can be expected of any good C source taken by gamers and scriptkiddies and \r
  41 collectively extended with half-baked features).\r
  42 \r
  43 a plan is to add lua scripting support at some point in the future, and the\r
  44 ugly and slow "C script" interpreter code can be removed and the good mods be\r
  45 converted to lua.\r
  46 \r
  47 Current Situation/Comparison with "official" OpenBOR\r
  48 ====================================================\r
  49 PAKS:\r
  50   since commit a10ae8340ac9187d2590fa0ce8a3390122b570e1 the internal layout of\r
  51   .pak files has changed to simplify things.\r
  52   filenames are stored in unix fashion (/) and lowercase only.\r
  53   to make old pak files compatible, they have to be "converted":\r
  54 \r
  55   extract them using the borpak tool in tools/borpak,\r
  56   then repack them using the same tool.\r
  57   this results in a fresh pak in the required format.\r
  58 \r
  59   this change made it possible to use extracted paks in a directory.\r
  60   you can simply create a directory in the Paks dir for each game\r
  61   (i.e. Paks/MyGame/data/)\r
  62 \r
  63 BLOAT:\r
  64   OpenBOR (anallyst edition) x64 binary           :  750 KB\r
  65   OpenBOR (lavalit edition, rev 3320)  x64 binary : 1250 KB\r
  66   OpenBOR (lavalit edition, rev 3600+) x64 binary : probably 1.5 MB+\r
  67 \r
  68 SPEED:\r
  69   anallysts work on OpenBOR made for huge speed improvements in loading times.\r
  70   most mods now load in an instant and took several seconds (up to minutes (!))\r
  71   formerly.\r
  72   this improvements have gone into the lavalit version as well, but some team\r
  73   members there prefer seeing a moving loading bar between levels over instant\r
  74   loading, so some of the optimisations has been removed by them.\r
  75   it's likely that the lavalit version will get slower and slower over time.\r
  76   \r
  77   this fork is currently the fastest openbor version available.\r
  78   \r
  79 MOD COMPATIBILITY:\r
  80   some upstream features have been ported so mods relying on OpenBOR 36xx features\r
  81   should work exactly as intended.\r
  82 \r
  83   compatibilty to older mods should be even better as the lavalit version\r
  84   as some bugs have been fixed that prevented some mods to work with anything\r
  85   newer than rev 28xx.\r
  86 \r
  87 PLATFORMS:\r
  88   support for any non-posix compatible game console has been removed.\r
  89   this fork builds well on any posix compatible platform that has ports\r
  90   of libogg/vorbis and SDL.\r
  91   this means it should build on any linux based device, *BSD, etc.\r
  92   possibly even mingw.\r
  93   we're taking the stance than rather to buy a commercial game console and\r
  94   crack it for homebrew usage, you should rather buy products that are intended\r
  95   for homebrewers and thus support the companies producing them.\r