Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 142 lines (96 sloc) 5.413 kB
695ddd4 @Spooner Added readme.
authored
1 h1. Zed and Ginger
2
e99eb92 @Spooner Added readme.
authored
3 <pre>
4 A cat runs!
5 See the cat run!
6 Why does the cat run?
7 ...To get to the end, of course.
8 </pre>
9
13a5c62 @Spooner Updated the readme.
authored
10 A single-player game of a cat running along a corridor in a space station just for the joy of it. Inspired by the classic arcade/8-/16-bit game, Metro-Cross.
e99eb92 @Spooner Added readme.
authored
11
b9e5a78 @Spooner Updated docs.
authored
12 Created using Ruby and the Ray gem.
695ddd4 @Spooner Added readme.
authored
13
14 License: GPL v3
6d80635 @Spooner Attempted fixes to make the game work on a German OS X machine.
authored
15 Website: http://spooner.github.com/games/zed_and_ginger
695ddd4 @Spooner Added readme.
authored
16 Author: Bil Bas (http://spooner.github.com) (bil dot bagpuss {at} gmail.com)
17
113a601 @Spooner Added requirements section
authored
18 h2. Requirements
19
20 * Since the game is implemented in a high level language, Ruby, it is significantly more CPU-bound than GPU-bound. That said, it should run well on a 1.5GHz machine and might be playable on slower machines.
21 * The game uses OpenGL shaders and so must be run with a graphics card that at least supports shaders (A card that supports Shader Model 2.0 should be fine; I don't use any new features).
22 * Game is known not to work with Intel integrated graphics (Anything better than that should really work :D).
9b84032 @Spooner Updated readme with scoring details.
authored
23
13a5c62 @Spooner Updated the readme.
authored
24 h2. Running the game
695ddd4 @Spooner Added readme.
authored
25
113a601 @Spooner Added requirements section
authored
26 Runs in a 768x480 window by default, but can be resized (larger or smaller) or run at native resolution (full-screen).
13a5c62 @Spooner Updated the readme.
authored
27
28 h3. _Windows_
29
30 * Run the executable:
31 <pre> zed_and_ginger.exe</pre>
32
33 h3. _OS X_
34
113a601 @Spooner Added requirements section
authored
35 Run from source:
36
13a5c62 @Spooner Updated the readme.
authored
37 * Ruby 1.9.2 or higher
38 * Ensure that GLEW and libsndfile are installed:
39 <pre> port install glew libsndfile</pre> or
40 <pre> brew install glew libsndfile</pre>
41 * Install bundler Ruby gem:
42 <pre> sudo gem install bundler</pre>
43 * Install Ruby gem dependencies from within the <i>zed_and_ginger</i> directory:
44 <pre> sudo bundle install</pre>
45 * Run the executable script:
46 <pre> ruby bin\zed_and_ginger.rbw</pre>
47
48 h3. _Linux_
695ddd4 @Spooner Added readme.
authored
49
113a601 @Spooner Added requirements section
authored
50 Run from source:
51
13a5c62 @Spooner Updated the readme.
authored
52 * Ruby 1.9.2 or higher
53 * Ensure that GLEW, libsndfile, Freetype, Xlib, OpenAL and OpenGL are installed:
d074a0f @Spooner Expanded installation instructions on Linux.
authored
54 - Kubuntu (Should work for Ubuntu and Debian variants):
55 <pre> sudo apt-get install libglew1.6-dev libsndfile1-dev libfreetype6-dev libopenal-dev</pre>
56 - Archlinux:
57 <pre> sudo pacman -S glew libsndfile freetype2 openal</pre>
58
13a5c62 @Spooner Updated the readme.
authored
59 * Install bundler Ruby gem:
60 <pre> sudo gem install bundler</pre>
61 * Install Ruby gem dependencies from within the <i>zed_and_ginger</i> directory:
62 <pre> sudo bundle install</pre>
63 * Run the executable script:
64 <pre> ruby bin\zed_and_ginger.rbw</pre>
9b84032 @Spooner Updated readme with scoring details.
authored
65
b9e5a78 @Spooner Updated docs.
authored
66 h2. How to play the game
67
68 * Player 1 (Zed) - WASD + space to jump.
69 * Player 2 (Ginger) - Arrows and Enter/Return to jump.
70
71 Keys can be configured in-game, in Controls.
72
24eba08 @Spooner Added music by Maverick.
authored
73
9b84032 @Spooner Updated readme with scoring details.
authored
74 h2. Scoring
75
76 The 100 best scores for each level are stored online. The game also stores your personal best score, so that you can
77 still advance your score if playing offline (and so you don't have to compete directly with others if you are terrible
78 at the game, like the author is).
79
80 Scores for each level are readable online at "GAMERCV":http://gamercv.com/gamers/9-spooner
81
82 h3. During a level
83
84 * Each tile crossed: 50 points
85 * Hyper-speed pill eaten: 500 points
86 * Giant ratoid chased (touched it): 250 points
87 * Giant ratoid eaten (landed on it): 1000 points + 1 second of extra time
88
89 h3. After completing a level
90
91 * Remaining time: 2000 points per second
92 * Hardcore mode: + 20%
93 * Inversion mode: + 20%
94
95
695ddd4 @Spooner Added readme.
authored
96 h2. Where to get a copy of the game from
97
13a5c62 @Spooner Updated the readme.
authored
98 * Downloads and feedback (TIGSource forum): http://forums.tigsource.com/index.php?topic=20797
695ddd4 @Spooner Added readme.
authored
99 * Project: http://github.com/Spooner/zed_and_ginger
100 * Repository: git://github.com/Spooner/zed_and_ginger.git
101
102
24eba08 @Spooner Added music by Maverick.
authored
103 h2. External assets
695ddd4 @Spooner Added readme.
authored
104
24eba08 @Spooner Added music by Maverick.
authored
105 * "Ray":http://mon-ouie.github.com/projects/ray.html (game-making library) [Included in executable versions].
106 * Original music by "Maverick (Brian Peppers)":http://polyhedricpeppers.weebly.com/. !http://i.creativecommons.org/l/by-sa/3.0/88x31.png(CC BY-SA)!:http://creativecommons.org/licenses/by-sa/3.0/
cea20a8 @Spooner Added credit for GLSL noise function.
authored
107 * 2D simplex noise function for GLSL copyright (C) 2011 Ashima Arts (Ian McEwan) under MIT license.
a7f285c @Spooner Credited Ippa with hosting the high-scores.
authored
108 * High-scores hosted by Ippa at "GAMERCV":http://gamercv.com
b9e5a78 @Spooner Updated docs.
authored
109
24eba08 @Spooner Added music by Maverick.
authored
110 h2. Tools used
695ddd4 @Spooner Added readme.
authored
111
13a5c62 @Spooner Updated the readme.
authored
112 * Ruby 1.9.3
24eba08 @Spooner Added music by Maverick.
authored
113 * Developed using "JetBrains RubyMine IDE":http://www.jetbrains.com/ruby/
114 * Graphics created with "GIMP":http://www.gimp.org/
115 * Sound effects created using "bfxr":http://www.bfxr.net/ and converted using "Audacity":http://audacity.sourceforge.net/
116 * Windows executable created with the "Ocra":http://ocra.rubyforge.org/.
695ddd4 @Spooner Added readme.
authored
117
b9e5a78 @Spooner Updated docs.
authored
118
2770c53 @Spooner Updated readme.
authored
119 h2. Credits
120
113a601 @Spooner Added requirements section
authored
121 * Many thanks to Mon-ouie for making the Ray library and generally putting up with me asking dumb questions about it.
c169ae4 @Spooner Remembered to credit kyrylo for Linux work.
authored
122 * Thanks to kyrylo for helping debug the Linux port.
b9e5a78 @Spooner Updated docs.
authored
123 * Thanks to BlueScope, eigenbom, Fowl (& sister), Ippa, jlnr, Mon-ouie, Peter Cakebread (& family) and SiliconEidolon for play-testing and comments.
124
695ddd4 @Spooner Added readme.
authored
125
126 h2. License
127
128 This program is free software: you can redistribute it and/or modify
129 it under the terms of the GNU General Public License as published by
130 the Free Software Foundation, either version 3 of the License, or
131 (at your option) any later version.
132
133 This program is distributed in the hope that it will be useful,
134 but WITHOUT ANY WARRANTY; without even the implied warranty of
135 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
136 GNU General Public License for more details.
137
138 You should have received a copy of the GNU General Public License
139 along with this program. If not, see <http://www.gnu.org/licenses/>.
140
141 Full text of the license is provided in COPYING.txt
Something went wrong with that request. Please try again.