Documentation Entry

Goal

Teach the class how local storage works, what it is and how it is useful or can be implemented into their own game.

Files Added

  • _projects/games/local-storage/levels/localStorageDemo.js
  • _projects/games/local-storage/notebook.src.ipynb
  • _projects/games/local-storage/images/chillguy.png
  • _projects/games/local-storage/images/forest.png

What We Implemented

We made an interactive lesson that taught everyone what/how to use local storage. It had gamerunner cells and multiple interactive games in it to help the reader truly understand the applications of local storage. Along with that, we had the code we used to add local storage, making it very easy for anyone to add it into their game.

How We Tested

  • Ran make dev
  • Used localhost to confirm our changes were what we wanted before pushing to github.
  • Checked that the gamerunner cells worked in localhost and deployed.
  • Verified the player sprite rendered and moved
  • Confirmed that the local storage in the gamerunner was correctly implemented and worked fine.

What We Learned

  • A level is easier to maintain and control when all of the files are in the same project
  • Taking your time to document all of your progress slowly over time helps show your progress and document all the small decisions made along the way to get to the final result
  • Documentation is a part of the building process, not extra work.

Next Step

Helping other groups implement local storage and adding better implementations of it in our own game.