Skip to content

Project Structure

cursorkeys edited this page Aug 16, 2021 · 5 revisions

The directory for the project is structures as below.

NOTE: The directory structure below is not enforced in any way, but it is the preferred way for GAME1. Using the preferred way makes it easier to compare your project to other projects, and example projects, or get support.

root
 \
   index.html 
	//contains html for the canvas, and initialization for the program

   statedefinitions.js 
	//contains playbook and state definitions

   XXXX.js 
	//all main javascript files

   res [DIRECTORY] //contains resources
    \
      lib
		//javascript libraries

      level
		//json or text files for level descriptions

      data
		//json or text files for other data descriptions

      anim
		//images, sprites and tiles. PNG and GIF files

      gfx
		//images, sprites and tiles. PNG, GIF and JPG files

      sfx
		//Sound resources. WAV and MP3 files

      msx
		//Music resources. MP3 and OGG files