  _____            _             _          
 / ____| v.0.97.1 | |           | |         
| (___  _ __   ___| |_   _ _ __ | | ___   _ 
 \___ \| '_ \ / _ \ | | | | '_ \| |/ / | | |
 ____) | |_) |  __/ | |_| | | | |   <| |_| |
|_____/| .__/ \___|_|\__,_|_| |_|_|\_\\__, |
       | |                             __/ |
       |_|                by Derek Yu |___/  (c) 2008

=====================
 INTRODUCTION
=====================

"Legends speak of a Colossal Cave that extends deep underground, so twisted
by time that its passages shift like the sand under which it lies... the Cave
is said to be filled with fabulous treasures, but also incredible danger!"

Spelunky is a cave exploration / treasure hunting game where the goal is to
grab as much treasure from the cave as possible.  Every time you play the
cave's layout will be different.  Use your wits, your reflexes, and the items
available to you to survive and go ever deeper!  Perhaps at the end you may
find what you're looking for...

Don't be afraid to die!  But also don't be afraid to live!  Happy Spelunky-ing!


=====================
 CONTROLS
=====================

NOTE: THE CONTROLS CAN BE CONFIGURED WHEN THE GAME LOADS.

Left, Right - Walk
Up          - Climb Ladders and Vines
Down        - Crouch
X           - Whip, Throw Item, Use Item
Z (or W, Y) - Jump
C           - Cycle Whip, Bombs, Rope
B           - Use Bomb Shortcut
R           - Use Rope Shortcut
F           - Flare
P           - Purchase/Bet
Esc         - Pause/Menu (Quit Game)

- To RUN, either start walking and then press down, or hold down either Shift,
Ctrl, Alt, or Spacebar while walking.  You can disable "Down for Running" when
the game first loads.

- To PICK UP ITEMS, crouch by them and press X.  You can throw them by pressing
X again.  Hold up to throw high, and down to drop.

- Certain items, like weapons, can be used, instead of thrown, with X.

- You start each game with 4 BOMBS and 4 ROPES.  To use them, cycle to them
with C and then press X to use.  The bomb must be armed first. Ropes can be
thrown upwards or downwards, depending on whether you're standing or crouching.

- You can HANG ON TO LEDGES by jumping into them.  You can also flip onto a
ledge by crawling over it.

- OPEN CRATES AND CHESTS by holding up and pressing X.

---------------------
 GAMEPAD SUPPORT
---------------------

Spelunky does support gamepads natively.  To use a gamepad, plug it into the
number 1 USB slot and then enable gamepads when the game starts.


           USB
            |
  LT        |       RT     Left Trigger  - Flare
            |              Left Bumper   - Bomb Shortcut
  ___LB     |     RB___    Right Trigger - Purchase/Bet
 /     \____=____/     \   Right Bumper  - Rope Shortcut
.                       .  D-Pad         - Move
|   |   9      10   4   |  Button 10     - Pause/Menu (Quit Game)
|  = =             1 3  |  Button 1      - Whip, Throw Item, Use Item
|   |               2   |  Button 2      - Jump
|                       |  Button 3      - Run
|      LA       RA      |  Button 4      - Cycle Whip, Bombs, Rope
|      ___________      |  Left Analog   - Move
'     /           \     ' 
 \___/             \___/


=====================
 ISSUES
=====================

1. The game just ends immediately after the setup screen!

- Your graphics card may not support Game Maker surfaces, which Spelunky uses.
  Try running the game with fullscreen "off" and see if that helps.

2. There are strange visual glitches in the game.

- That is probably another graphics card issue.

3. The game runs slowly on my computer!

- Try turning "High Detail" off when the game loads.  Sorry, Game Maker is
rather slow and I'm not the best programmer!

4. This game is too hard!

- Spelunky is more like a "roguelike" game in that death is fast and always
  permanent.  It adds a certain tension to the game that makes it compelling.
  In short, you're meant to die many times before you complete the game, if
  ever.  It's not an easy game.

5. I have something to tell you about the game!

- I'd love to hear it!  Contact me at yu.derek@gmail.com.


=====================
 LICENSE
=====================

Spelunky is freeware.  Feel free to distribute it, so long as you include all
the files, including the executable, this readme, and the sounds folder.


=====================
 CREDITS
=====================

This is a GAME by Derek Yu (http://www.derekyu.com).  It was MADE WITH Mark
Overmars' Game Maker 7.0 (http://www.yoyogames.com/make). 

The BASIC PLATFORM ENGINE was by Martin Piecyk
(http://www.pages.drexel.edu/~mfp27/platformengine/).

The MUSIC was by George Buzinkai (http://buzinkai.net), and Jonathan Perry
(http://www.jonperry.com).  Derek Yu created the Ghost Theme, which was made
with Pixel's PXTone (http://pxtone.com).

The SOUND EFFECTS were created in Dr. Petter's SFXR
(http://www.cyd.liu.se/~tompe573/hp/project_sfxr.html).

This game incorporates ChevyRay's SCREEN-SCALING SCRIPTS.

BETA TESTING was handled by Annabelle Kennedy, Chutup, GeneralValter, Guert,
Graham Goring, Haowan, Hideous, Inane, increpare, Kao, Melly, Paul Eres, Super
Joe, Terry, Xion, Zaphos, Mark Johns, Benzido, Team Quiggan, and tantan.

MANY THANKS to Matt Thorson for help implementing gamepad support.  And also
Alec, Aquanoctis, azeo, Bob le Moche, Brandon McCartin, Devlin, dock, Drakkar,
Eclipse, Farbs, FishyBoy, Gainsworthy, KniteBlargh, kYn, lowpoly, mirosurabu,
Mr. Yes, nanotie, Nitro Crate, PaleFox, Pishtaco, Powergloved Andy, Saladan0,
sergiocornaga, Sparky, teknogames, and The-Imp for general feedback and bug-
reporting starting with v0.97.

The game takes INSPIRATION from many things, including Spelunker (NES), La
Mulana (http://agtp.romhack.net/project.php?id=lamulana), Balding's Quest
(http://forums.tigsource.com/index.php?topic=46.0), Aztec (Apple II), Nethack
(http://www.nethack.org/), Indiana Jones, and, maybe possibly, Cave Story
(http://www.cavestory.org/)!

SPELUNKY is a game that would not exists without the help of many people.
My thanks to them!

Shout out to Fran! <3


=====================
 VERSION HISTORY
=====================

---------------------
 0.97.1 - 12/25/2008
---------------------

= Added some original beta testers to the credits that were missing.

- Fixed fatal error: held items were still causing crashes when leaving
  player's hands in certain situations.
- Fixed bug: pressing action key skips [SECRET]'s dialogue entirely.
- Fixed bug: holding down run but not left or right should stop player
  instantaneously.
- Fixed bug: level generation creating broken paths.
- Fixed bug: breaking Mattock left invisible Mattock behind.
- Fixed bug: [SECRET] dropping priced item when near shops.
- Fixed bug: skipping intro flavor text would sometimes cause two characters
  to appear instead of just one.
- Fixed bug: certain enemies were not counting as kills, or were being counted
  as other enemies.
- Fixed bug: enemies killed by environment were counted as player kills.
- Fixed bug: enemies outside of room are now destroyed.

---------------------
 0.97 - 12/24/2008
---------------------

+ Added: key configuration.
+ Added: gamepad support.

= Let the player replay the tutorial from the title screen.
= Removed possibility of trapped chest from tutorial.
= Dropping ropes into the ground/wall now impossible.
= Let player run by holding down action key.
= Let player duck when standing between solid and platform.
= [SECRET] now only appears after level 1.
= [SECRET] now only appears after warning, with change in music.
= [SECRET] now turns [SECRET] into [SECRET].
= Prevented [SECRET] from appearing inside a tree.
= Increased message timeout.
= Made [SECRET]'s power more obvious.

- Fixed fatal error: hitting a key during fade-in/fade-out during credits
  could hang the game.
- Fixed fatal error: held items would randomly cause a crash.
- Fixed bug: in End Game, door opened prematurely.
- Fixed bug: shopkeepers getting angry over items they're not selling.
- Fixed bug: close window button now works.
- Fixed bug: "YOU GOT THE..." message repeating.
- Fixed bug: could use up flares on title screen.
- Fixed bug: unable to use rope/bomb shortcuts while holding an item.
- Fixed bug: skulls and jars shatter if held when exiting a level.
- Fixed bug: could see [SECRET] description prematurely.
- Fixed typo in introduction: "furroughed" instead of "furrowed."

---------------------
 0.96.1 - 12/21/2008
---------------------

First public release.