]> Dogcows Code - chaz/yoink/blob - README
preliminary AM_SILENT_RULES support
[chaz/yoink] / 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 headers
34 libvorbis
35 Lua
36 OpenAL
37 OpenGL
38 SDL
39 SDL_image (with libpng support)
40
41 c) License
42
43 The new code is released under the BSD-2 license. The old code and
44 original resources are provided under the zlib/libpng License. See COPYING
45 for complete details. The full texts of applicable licenses can be found
46 in doc/licenses/.
47
48
49 II. Developer
50 -------------
51
52 a) Notes regarding the code
53
54 The code is a complete rewrite, containing none of the original code. I've
55 made some effort to put the more generic or reusable code into a separate
56 library called Moof. I've also made an effort to incorporate 3rd-party
57 code that happened to fit well into what I needed. So, generally, the
58 source code is separated into these three categories:
59
60 1. Yoink-specific code.
61
62 This is the code directly in src/. These classes reside in no namespace.
63
64 2. Reusable code.
65
66 Currently, the code is in src/Moof/, and it is compiled as a convenience
67 library. These classes and other helper functions reside in the Mf
68 namespace. Since I wrote this code alongside the Yoink-specific stuff,
69 there is somewhat of a blurry line between the two categories.
70
71 3. 3rd-party code.
72
73 This is made up of free code from other projects or libraries (aside from
74 the explicit dependencies above), the licenses of which are also in the
75 COPYING file. This code resides in various namespaces and in various
76 subdirectories.
77
78 b) Porting
79
80 Portability is a goal of this project. To this end, Yoink is written in
81 standard C++ and takes advantage of cross-platform libraries. If code
82 changes are required to cleanly build Yoink on your platform, please send
83 back patches.
84
85
86 III. Packagers
87 --------------
88
89 a) The build system
90
91 You can probably tell that the build system of this package is built from
92 autoconf and automake. It should be fairly sane. If you find any
93 problems, especially any bugs which complicate packaging on certain
94 systems, please send back patches.
95
96 b) Targeting Win32
97
98 If you have a working mingw32 toolchain with all the dependencies, you can
99 build a win32 binary using a command such as this:
100
101 ./configure --host=mingw32 --prefix=/usr/mingw32/usr
102
103 where mingw32 is the correct name of your toolchain. You can get all the
104 non-standard dependencies from the git repository at win32/win32-libs.zip.
105 Just unzip the contents of that archive into your toolchain. If everything
106 goes smoothly, you should have a yoink.exe appropriate for the win32
107 platform. You can then build a complete installer using "make package" if
108 you have nsis installed.
109
This page took 0.032416 seconds and 4 git commands to generate.