diff --git a/README.md b/README.md index 68fc7af..d3627e5 100644 --- a/README.md +++ b/README.md @@ -2,39 +2,56 @@ FullScreenMario =============== An HTML5 remake of the original Super Mario Brothers - expanded for modern browsing. + ------------------------------------------------------------------------------------ +## How to Play + +Because of the legal issues this can't be hosted anymore on www.fullscreenmario.com, but +with these steps you can run it inside a cloud IDE in your browser without having to download +anything. + +[![IDE](https://codio-public.s3.amazonaws.com/sharing/demo-in-ide.png)](https://codio.com/p/create/?from_github=Diogenesthecynic/FullScreenMario) + +* Select `Preview > Project Index`. +* Select `Preview > New Browser Tab`. +* Click `Preview` and then click inside the game area. +* Enjoy + + +## Cheat Codes + Here's a quick set of cheat codes you can use during the game. If you're using this through the fullscreenmario.com UI, you'll have to reference everything as a member of 'game' (which is a link to the frame containing FSM). -Game Powerups -------------- +### Game Powerups + - + - + - + - + - + @@ -43,15 +60,15 @@ Game Powerups
Command Result
marioShroom(mario) The equivalent of Mario touching a Mushroom or FireFlower item.
marioStar(mario) The equivalent of Mario touching a Star item. Note that if you want Mario to be invincible for the rest of the current map, use ++mario.star.
scrollMario(X) Scrolls the window horizontally by X, keeping Mario in the same spot relative to the screen.
scrollTime(T) Floats Mario through the rest of the level (beware, this is best used on the Random worlds!).
fastforward(T) Sets the game speed to 1+T. T=1 results in double the speed, and T=0 is normal speed.
-Adding Things -------------- +### Adding Things + - + - + - +
Command Result
addThing(ThingFunction, xloc, yloc) @@ -60,16 +77,15 @@ Adding Things Creates a new instance of a Thing, such as Goomba or Koopa, at the specified location. Thing functions are located as separate in things.js; in the future they will be stored as JSON objects.
killNormal(MyThing) Kills a specified Thing. You may find them listed under window.characters, window.solids, and window.scenery.
-Map Shifting ------------- +### Map Shifting @@ -86,7 +102,7 @@ Map Shifting - + - + @@ -112,15 +128,14 @@ Map Shifting Shifts to the Nth location in the current map. For example, setMap(1,1); shiftToLocation(2); brings the user to the Underworld section of World 1-1. Note that maps are stored under Maps/WorldAB.js as function bodies. - +
Starts the World A-B map immediately. If it doesn't exist (such as when maps aren't loaded via AJAX yet), it will log a complaint gracefully.
setMapRandom() @@ -103,7 +119,7 @@ Map Shifting
shiftToLocation(N)
-Level Editor ------------- +## Level Editor - + - +
loadEditor() @@ -129,12 +144,11 @@ Level Editor Starts the in-game level editor.
-Developers & Legal ------------------- +## Developers & Legal This is released under the Attribution Non-Commercial Share-Alike license. Full Screen Mario is meant to be both a proof of concept and an entertaining pasttime, not a source of income. -The whole project was originally hosted under www.fullscreenmario.com, but that site was taken down by Nintendo for copyright infringement. \ No newline at end of file +The whole project was originally hosted under www.fullscreenmario.com, but that site was taken down by Nintendo for copyright infringement.