Dogcows Code - chaz/yoink/blob - README

   1
   2 Yoink - The alien-smashing action game
   3 --------------------------------------
   4
   5 Contents:
   6
   7 I.   Users
   8   a)   General information
   9   b)   Requirements
  10   c)   License
  11 II.  Developers
  12   a)   Notes regarding the code
  13   b)   Porting
  14 III. Packagers
  15   a)   The build system
  16   b)   Targeting Win32
  17
  18
  19 I. Users
  20 --------
  21
  22 a) General information
  23
  24 Yoink is a game originally developed by Neil Carter for Mac OS.  You play
  25 the part of a flying alien heroine who must defend her home on Earth from
  26 other airborne alien invaders.
  27
  28 This version of the game uses all new code and modern frameworks to bring
  29 this simple, fast-moving action game to a wider audience.
  30
  31 b) Requirements
  32
  33 boost
  34 headers
  35 freealut
  36 libvorbis
  37 Lua
  38 OpenAL
  39 OpenGL
  40 SDL
  41 SDL_image (with libpng support)
  42
  43 c) License
  44
  45 The new code is released under the BSD-2 license.  The old code and
  46 original resources are provided under the zlib/libpng License.  See COPYING
  47 for complete details.  The full texts of applicable licenses can be found
  48 in doc/licenses/.
  49
  50
  51 II. Developer
  52 -------------
  53
  54 a) Notes regarding the code
  55
  56 The code is a complete rewrite, containing none of the original code.  I've
  57 made some effort to put the more generic or reusable code into a separate
  58 library called Moof.  I've also made an effort to incorporate 3rd-party
  59 code that happened to fit well into what I needed.  So, generally, the
  60 source code is separated into these three categories:
  61
  62 1. Yoink-specific code.
  63
  64 This is the code directly in src/.  These classes reside in no namespace.
  65
  66 2. Reusable code.
  67
  68 Currently, the code is in src/Moof/, and it is compiled as a convenience
  69 library.  These classes and other helper functions reside in the Mf
  70 namespace.  Since I wrote this code alongside the Yoink-specific stuff,
  71 there is somewhat of a blurry line between the two categories.
  72
  73 3. 3rd-party code.
  74
  75 This is made up of free code from other projects or libraries (aside from
  76 the explicit dependencies above), the licenses of which are also in the
  77 COPYING file.  This code resides in various namespaces and in various
  78 subdirectories.
  79
  80 b) Porting
  81
  82 Portability is a goal of this project.  To this end, Yoink is written in
  83 standard C++ and takes advantage of cross-platform libraries.  If code
  84 changes are required to cleanly build Yoink on your platform, please send
  85 back patches.
  86
  87
  88 III. Packagers
  89 --------------
  90
  91 a) The build system
  92
  93 You can probably tell that the build system of this package is built from
  94 autoconf and automake.  It should be fairly sane.  If you find any
  95 problems, especially any bugs which complicate packaging on certain
  96 systems, please send back patches.
  97
  98 b) Targeting Win32
  99
 100 If you have a working mingw32 toolchain with all the dependencies, you can
 101 build a win32 binary using a command such as this:
 102
 103 ./configure --host=mingw32 --prefix=/usr/mingw32/usr
 104
 105 where mingw32 is the correct name of your toolchain.  You can get all the
 106 non-standard dependencies from the git repository at win32/win32-libs.zip.
 107 Just unzip the contents of that archive into your toolchain.  If everything
 108 goes smoothly, you should have a yoink.exe appropriate for the win32
 109 platform.  You can then build a complete installer using "make package" if
 110 you have nsis installed.
 111