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