2 .\" Copyright (c) 2009-2011, Charles McGarvey
3 .\" All rights reserved.
5 .\" Distributable under the terms and conditions of the 2-clause BSD
6 .\" license; see the file COPYING for a complete text of the license.
13 .Nd general information about yoink
15 Yoink is a game created by Neil Carter for Mac OS. You play the part of a
16 flying alien heroine who must defend her home on Earth from other airborne
19 This version of the game uses all new code and modern frameworks to bring
20 this simple, fast-moving action game to a wider audience.
22 Installing Yoink is simple. You can typically use commands such as these:
26 .D1 make && make install
28 This will install Yoink into the
30 directory. To run Yoink, issue the command:
32 .D1 /usr/local/bin/yoink
42 for a more detailed discussion about the build system and a list of
45 The new code is released under the 2-clause BSD license. The old code and
46 original resources are provided under the zlib/libpng license. See the file
48 for complete details. Other parts are distributed under different licenses.
51 for the full texts of the relevant licenses.
53 The code is a complete rewrite, containing none of the original code. I've
54 made some effort to put the more generic or reusable code into a separate
55 library called libmoof. I've also made an effort to incorporate 3rd-party
56 code that happened to fit well into what I needed. So, generally, the
57 source code is separated into these three categories:
60 Yoink-specific code. This is the code in the
62 directory. These classes reside in no explicit namespace.
64 Reusable code. The code is in
66 and it is compiled as a convenience library. These classes and helper
67 functions reside in the moof namespace. Since I wrote this code alongside
68 the Yoink-specific stuff, there is somewhat of a blurry line between the
69 two categories, unfortunately.
71 Third-party code. This is made up of free code from other projects or
72 libraries, the licenses of which are also noted in the
74 file. This code resides in various namespaces and in various
79 Here are some tips to help packagers:
82 The build scripts are written in Lua, so make sure the Lua interpreter is
83 installed. That shouldn't be a problem since Yoink depends on the Lua
88 will only work well with GNU make. On some systems, this is installed as
93 script supports most of the useful options that an Autoconf-generated
94 script would have, and the
102 for a more detailed discussion about the build system.
104 I'll gladly entertain patches if you want to help out. Just email me your
105 stuff or tell me where to pull if you use git. If you're interested in
106 that, please observe the following:
109 Stick to the coding style of the source code files you edit. Follow the
110 general style of method and variable naming, as well as white space
111 formatting. In particular, use literal tabs with an assumed tabstop of 8
112 characters. Also, try to limit line lengths to 78 characters.
114 For legal reasons, don't include other peoples' code with your patch. You
115 must also agree to license your changes according to the same terms and
116 conditions as the files you edit, usually the 2-clause BSD license.
118 If you want your name and contact information in the
120 file, please make it so in the patch you provide.
126 .Bl -tag -width 2i -compact
127 .It An Charles McGarvey