JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
markdownify readmes
[vor.git] / README.md
1 # Variations on Rockdodger 0.5.7
2
3 VoR is a quick action game where you drive a space ship and try to avoid
4 crashing into rocks. Current information about vor can be found on the
5 homepage: https://sametwice.com/vor
6
7 Here are the keys:
8
9      Space: Start playing
10          1: Switch to easy mode and start playing
11          2: Switch to normal mode (default) and start playing
12     Arrows: Steer (use short taps, and remember to slow down)
13        Esc: Quit
14          F: Toggle full-screen mode
15          P: Pause/unpause
16          3: Save a screenshot
17
18 See INSTALL for instructions on building, running and installing.
19
20 VoR is released under the GNU GPL -- see file COPYING for details. The audio is
21 public domain.
22
23 Jason Woofenden and Josh Grams like Rock Dodgers (a game by Paul Holt:
24 http://spacerocks.sourceforge.net/) very much: both playing it and hacking on
25 it. VoR is the result. It is currently based on the rockdodger 0.4.2 codebase,
26 with quite a few modifications, both user-visible changes and internal
27 technical improvements.
28
29 Available for download from https://sametwice.com/vor
30
31 Note: This is a fairly hard game, intended to be a quickie game for when you
32 want to kill a few spare minutes. For reference, my best time [Josh Grams] is
33 about 2 minutes in version 0.3. I'm not generally very good at video games, but
34 I have been playing this one for quite a while now.
35
36
37 ## Changes from Rock Dodgers
38
39 User-Visible Changes:
40
41 0.5.6:
42   * Some rocks disappear when hit by your exploding ship sparks
43
44 0.5.4:
45   * new sound effect and music
46   * F key toggles full-screen mode
47   * 3 key saves a screenshot
48
49 0.5.3:
50   * another attempt at fixing the x86 crashes.
51   * made valgrind happy.
52
53 0.5.2:
54   * another attempt at fixing the x86 crashes.
55
56 0.5.1:
57   * another attempt at fixing the x86 crashes.
58
59 0.5:
60   * lots of bug fixes
61   * tweaks to engine and explosion graphics and new font
62
63 0.4:
64   * Rocks now bounce off each other, and are pushed by particles.
65   * Now with two difficulties: normal and easy.
66   * Better new ship placement after you die.
67
68 0.3:
69   * Scrolls to the right so you can zoom ahead.
70   * Fully random rock generation; rocks no longer wrap vertically.
71   * Rocks' relative speeds are now uniform in all directions (i.e. much more
72     up/down speed variation).  Noticeably hard...err...more "interesting".
73   * Command-line option --game-speed.
74
75 0.2:
76   * New graphics, generated by POV-Ray. Yeah, okay, the ship is really cheesy.
77     At least the rocks are cool.
78   * Real collision detection; no more "ship is 1 pixel bigger all around
79     than it looks."
80
81 0.1:
82   * Moves like a real spacecraft; no more friction!
83   * No more silly shields or lasers; just pure rockdodgin' fun!
84   * Up/down scrolling; gives you more escape options.
85   * Proper time display for score, not just raw milliseconds (bleh).
86   * Ship explodes, blowing rocks away, rather than automagically vanishing
87     them.
88
89 Internal Technical Changes:
90
91   * Build system now uses autoconf (as of 0.5.5)
92   * Replaced SFont with Jason's font.c
93   * Started factoring a lot of stuff out of main into their own .c files.
94   * Removed a bunch of unused code.
95   * Function definitions: name at beginning of line (line following the return
96     type) for easy grepping as per GNU coding standards.
97   * Real collision detection (bbox/bitmask).