Prison

A long road to become a pattern-maker.

A simple game allowing you to create your own tiled maps and load it with phaser.io as a game.

• WebApp: http://bit.ly/prisonApp

• Github: https://github.com/Morabaraba/Prison

• Docs: http://bit.ly/prisonApp-docs

Ubuntu

If you have nothing installed on your machine and just want to get this project going follow the instructions below.

Execute the following commands from your ubuntu terminal:

	sudo apt-get install npm tiled
	sudo npm install bower grunt-cli -g 
	
	mkdir ~/project
	cd ~/project/
	URL=https://github.com/Morabaraba/Prison.git
	git clone $URL
	cd prison

OS X

Brew, I believe all the tools installs easily enough from a OS X side that I don't have to waste bytes.

Setup

If everything went well you have the power of a thousand JavaScript ninja warriors, the current facebook generation.

Now let us setup our local packages and tools for our project. Starting with the node package manager(npm).

	npm install
	bower install

npm install install all the packages as specified in vim package.json.

You can change the resolution of your game in vim config.json.

Play

If everything went well you can:

	grunt

You will then see our first prison in your browser. Move around with the up, down, left, right.

Now you can go play in vim game/states/play.js and after each :w in vim, your web browser should refresh with your updated javascript to the play state of the game. This also counts for any assets you have in the cd assets directory. We use tiled to create our assets/maps/prison.json file. I started with my own 2d(twod) set of tools wrapping phaser.io objects to create a game, and you will see I'm building my own property system on tiled, linking:

digraph tiled_twod_phaser_diagram {
	"tiled"->"twod"
	"twod"-> "phaser";
}

I will document this as I go along but I'm mostly working in game/prefabs and around the other states. Please note this project was created with the official-phaser yo generator, so install yo, and help me figure out how the two sub-generators work.

sudo npm install yo generator-official-phaser -g

but I'm leaving vim assets/prison.json and vim game/states/play.js for each player to decide if they want to follow my game, or create their own. If you do create your own game, please share it with me, or you can help by giving me feedback and correcting me when I bastardize your favourite tool.

The Grunt

Grunt creates dist/ and he feeds our browser. You can change the settings that will be passed for the bootstrapper in vim config.json you can change the template that generates the main.js in:

	var bootstrapper = grunt.file.read('templates/_main.js.tpl');

License

The MIT License