refactoring the scene class
[chaz/yoink] / README
1
2 Yoink is a game originally developed by Neil Carter for Mac OS X. You play
3 the part of a flying alien heroine who must defend her home on Earth from
4 other airborne alien invaders.
5
6 This version of the game uses rewritten code and modern frameworks to bring
7 this simple, fast-moving action game to a wider audience.
8
9 The new code is released under the Simplified BSD License. The old code and
10 original resources are provided under the zlib/libpng License. See COPYING
11 for complete details.
12
13 Dependencies:
14
15 boost headers
16 OpenGL (libGL, libGL or opengl32, glu32)
17 libSDL
18 libSDL_image (with libpng support)
19 libSDL_sound (with libogg support)
20 libopenal
21 libalut
22
23
24 Notes regarding the code:
25
26 I've made some effort to put the more generic or reusable code into a separate
27 library called Moof. I've also made an effort to incorporate 3rd-party code
28 that happened to fit well into what I needed. So, generally, the source code is
29 separated into these three categories:
30
31 1. Yoink-specific code.
32
33 This is the code directly in src/. These classes reside in no namespace.
34
35 2. Reusable code.
36
37 Currently, the code is in src/Moof/, and it is compiled as a convenience
38 library. These classes and other helper functions reside in the Mf namespace.
39 Since I wrote this code alongside the Yoink-specific stuff, there is somewhat of
40 a blurry line between the two categories.
41
42 3. 3rd-party code.
43
44 This is made up of free code from other projects or libraries (aside from the
45 explicit dependencies above), the licenses of which are also in the COPYING
46 file. This code resides in various namespaces and in various subdirectories.
47
This page took 0.035796 seconds and 4 git commands to generate.