minimalist-gameforks / spelunky Goto Github PK

  _____            _             _          
 / ____| v.1.1    | |           | |         
| (___  _ __   ___| |_   _ _ __ | | ___   _ 
 \___ \| '_ \ / _ \ | | | | '_ \| |/ / | | |®
 ____) | |_) |  __/ | |_| | | | |   <| |_| |
|_____/| .__/ \___|_|\__,_|_| |_|_|\_\\__, |
       | |                             __/ |
       |_|                by Derek Yu |___/  Copyright (c) 2008, 2009
                                             Mossmouth, LLC

<http://www.spelunkyworld.com>

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

Hey, people!  I'm releasing the source code in the hopes that you can
learn from it and create some cool stuff of your own.  I apologize in
advance if anything is not as straightforward, efficient, or clean as it
could be.  I did my best to provide comments where necessary!


=========================
 OPENING THE SOURCE
=========================

To open the .gmk files, you will need some version of Mark Overmars's
Game Maker (I used both version 7.0 and 8.0).  It can be obtained for
$25 from <http://www.yoyogames.com/make>.

To obtain the data files required to play the game, download Spelunky from
<http://www.spelunkyworld.com>.


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

You can redistribute and/or modify Spelunky, including its source code, under
the terms of the Spelunky User License.  You may not sell Spelunky.

Spelunky is distributed in the hope that it will be entertaining and useful,
but WITHOUT WARRANTY.  Please see the Spelunky User License for more details.

The Spelunky User License should be available as an external file called
COPYING.  If not, please obtain a new copy of Spelunky from the official
website at <http://spelunkyworld.com/>.


=========================
 CONTACT
=========================

Email: <[email protected]>
Forums: <http://mossmouth.com/forums/index.php?board=6.0>

Unfortunately, I can't commit to answering every question about the source
code.  Your best bet is to post on the forums!  Your question may have
already been answered there.


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

Some smart and generous people have made Game Maker a lot better by extending
its basic functionality with scripts.  I used the following in Spelunky:

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

The game uses tsg1zzn's SUPER SOUND SYSTEM library for Game Maker to play
OGG VORBIS music files and do CROSS-FADING and PANNING.

The game incorporates ChevyRay's VIEW-SCALING SCRIPTS.
<http://forums.tigsource.com/index.php?topic=3142.msg86809#msg86809>

Many thanks to these guys for sharing their work.


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

--------------------
 1.1 - 12/25/2009
--------------------