towerofnix / slw

name blatantly borrowed under fair use from @an-ok-squirrel

Super Liam World

Play online!

-100% original amazing platforming game.

Developing

First you'll want to get everything installed:

$ yarn global add flow-bin gulp-cli    # Flow https://flowtype.org/ & Gulp
$ yarn                                 # The actual thing

# or

$ sudo npm i -g flow-bin gulp-cli      # Flow https://flowtype.org/ & Gulp
$ npm install                          # The actual thing

Then you'll want to start getting the app being built:

$ gulp build    # once
$ gulp watch    # for changes

(With watch, whenever you make changes to the src folder, everything will automatically be rebuilt.)

You also need to run a webserver because of browser security rules. Any of these might work:

$ python2 -m SimpleHTTPServer
$ python3 -m http.server
# or try node-http-server: https://www.npmjs.com/package/node-http-server

Also please run flow decently frequently because it might help you with issues and stuff. (Also it would be nice if no errors came from flow!) (Also you should really just get a flow linter or whatever for your favorite text editor. It hopefully exists.)

Credits for things

• SFX: Super Mario World
• Tilesets:
  • theundead101
  • Super Mario World (+ edits)
  • Random.Nick, Shikaternia, Black Squirrel
  • ArnuroMinigon
• Sprites: Super Mario World (+ edits)
• Music:
  • File Select: Training Course - SMW2
  • Grassland: Bob-omb Battlefield - SM64 [Remix]
  • Athletic: Double Cherry Pass - SM3DW [Remix]
  • Underground: Mario 1 Underground - SMAS [Remix]
  • Ice Cave: Underground - SMW2
  • Beach: Mario 3 Athletic - SMAS
  • Water: Dire, Dire Docks - SM64 [Remix]
  • Airship: Mario 1 Airship - SMM [Remix]
  • Jungle: Castle/Fortress - SMW2
  • Castle: Castle - NSMB [Remix]
  • Fortress: Castle - NSMB Wii [Remix]
  • Desert: Stonecarving City - WL: SI [Remix]
  • Ghost House (1): Mario 1 Ghost House - SMM [Remix]
  • Ghost House (2): Mario 3 Ghost House - SMM [Remix]
  • Map - Flower Gardens: Onett - Earthbound
  • Map - Underwater Underworld: Threed, Free at Last - Earthbound
  • Map - Chilly Tropics: Delfino Plaza - SMS
  • Map - Kapper Canyon: Sammer Kingdom - SPM [Remix]
  • Map - Poison Pond: Mario 3 Pipe Land - SMAS
  • Map - Lava Lair: X-Naut Fortress - PM: TTYD [Remix]
  • Map - Star World: World Bowser - SM3DW [Remix]

slw's Issues

Add invisible block

...and easter eggs

Moving up on world map causes airpunch event

Kinda stupid issue that should never really cause any issues, but.. that would probably be worth fixing at some point, just in case!

You can move to the block

Using <- & -> you can enter to block's field

Editor camera position

ATM the editor camera position is completely different from the player position. I think it'd be more helpful if the editor camera followed the player (only as soon as you enter the editor, though, of course).

Small player spritesheet

We need a spritesheet that we can use for the "small Mario" form - e.g. on the World Map and when a mushroom has not been collected yet. (Whatever is found will probably need recolouring)

World Map

We need an overworld and level selector - this should make other features trivial e.g. the death zone sends one back to map.

Jumping through solidTop blocks is jittery

e.g. cloud blocks, donut blocks.

Pretty sure this has something to do with floor/ceiling the Y position on "collision", even though your YV isn't getting reset.

Make "camera" follow player

Just modifying getDrawnPosition and let view(start/end)(x/y) should do it.. this is what I was having trouble with earlier, though! :P

Can't build

I'm reproduced steps in README.md, but after gulp build I can't run game ;(

Don't make code lines longer than 80 characters please

❤️

WASD controls

Moving with the arrow keys and space is comfortable - right hand on arrow keys, left thumb on spacebar, easy. But in the editor, you use the mouse. So generally you'd have your right hand on the mouse, and.. your left hand on the arrow keys. That doesn't feel very good. Having WASD controls be supported additionally would solve that - right hand on mouse, left on WASD (you could even still have your left thumb on the spacebar if you prefer).

Punching a block doesn't reset yv

Case-in-point:

Each block makes a hit sound, causing.. many. This can also sometimes result in a crash.

Physics

Kinda important

• Floor collision
• Wall collision
• Ceiling collision

Animations/imagery for Entities

• Player (needs implementation)
• Goombas
• Other enemies. Suggest!

how do I build

i am sorry I AM NOT A COMPUTER PERSON!!!!

Store tiles in a better way than just characters

That's good for making the level but we should probably store them better :D

Level editor?

We've been hinting at this for a while - we need a proper level editor for SLW. Editing a single tilemap layer in src/levels.toml is going to get really ugly and it'd be nice to have anyway.

And as we all know, I ❤️ polish, so if we can make the editor Super Mario Maker-like, it'd be awesome 😄

Level saving

Not sure how to go about doing this. I think that going into the editor and then out should probably reload the level, but I'm not sure how well that'll fare with lag in the future (hopefully shouldn't be a problem..).

Think about the goomba tile. When a goomba tile is created, it's immediately replaced with an air tile, and a goomba is spawned. So how do you place and save a goomba tile? It needs to be stored in some way separate from the main tile list (which will be used for saving/loading)..

entityUpdate should be renamed to updateEntities

Just keeping note because it wouldn't fit in my next commit.

Go through pipes

This'll be a bit difficult -- the player needs to be rendered under the pipe tiles..

Uglify removes `debugger`

..Which is really annoying.

I've removed uglify from gulp (commented it out) for the time being (locally). It might not be a bad idea to have yet another build script to uglify things but that could be unnecessary, especially early in this project... I wonder if it should be an argument to the gulp/buildJs call? (think gulp watch --uglify)

General Entity class

..for Player to subclass from. Later on, Enemys, Powerups, and so on.

Entities don't move

Crouching / Ground-pounding

See the crouch branch.

Things left to do:

• Fix this:
  
• Get/add crouch/groundpound sprites for state 0 (small player)
• Get/add groundpound sprite for state 1 (large player)

Destroying a level doesn't remove entities

Kinda funny spawning a mushroom in F-2 and then using it in F-1. But obviously a bug.

Add death state

Here:

Add lint check for line length

This checks line length (80) automatically.

Add control buttons for mobile devices

     [-------------]
     [  Stage  ]
     [-------------]
  _
_|  |_         (A)
_   _|
 | |