Skip to content

alexdantas/rabbit-hole

Repository files navigation

Rabbit Hole

logo

Simple HTML5 2D platformer, initially made for the Ludum Dare #29. Powered by melonJS, it works on most web browsers, including mobile devices.

Gameplay

You're Ceci, a cute girl in a rabbit outfit, who has to save her friends from a burning on the Rabbit Hole; a huge cave filled with all sorts of things.

Avoid the fire, collect stars on the way, fight the strange walking-fire-people and make sure to leave no friend behind!

Controls

key action
Arrow keys or WASD Walk and jump
Hold Shift Run

This game supports touch screens.

touch/click at... action
Upper area Jump
Lower-right area Run right
Lower-left area Run left

Instructions

To play the game right now, follow this link.

If you want your own local version, download the repository, start a web server and open index.html on your favorite browser.

Note that this repository is a development version of the game. It splits the code over several .js files.

You can build a production version, that compresses all the .js files into minified versions. This way it'll be way faster to load the game. It is the recommended way to host it on your own website.

To build, be sure you have node installed. On the project directory, run:

npm install

And then:

grunt

Development

Here's how the code is laid out:

directory contents
index.html Entry point for the game; visual elements
data All resources; images, audio, fonts, maps...
data/audio All things related to sound
data/audio/bgm Background music, songs
data/audio/sfx Sound effects
data/image All images
data/image/font Bitmap fonts
data/image/gui Backgrounds and borders for game screens
data/image/tile Tilesets used on the Tiled maps
data/image/sprite Spritesheets or single sprites
data/map Tiled maps
js Source code for the whole game; main .js files
js/entities Things that interact with each other (player, enemies...)
js/states Game states (screens that can be shown
js/gui Components of the user interface (menu, buttons...)
lib Libraries used for the game (MelonJS)
lib/plugins MelonJS plugins
css Stylesheets

Credits

The team:

  • Developer: Alexandre Dantas (homepage)
  • Artist: Natália Cristina Alves Barros (deviantArt)

Acknowledgments:

License

The whole code is released under the MIT-license.

Check file LICENSE.md for details on what you can and cannot do with it.

About

Rescue your friends on this huge cave! HTML5 2D Platformer

Resources

License

Stars

Watchers

Forks

Packages

No packages published