denki_guy 0.1.0

data/README.markdown

@@ -0,0 +1,47 @@
+Denki Guy
+=========
+
+Denki Guy (電気ガイ) is an electrician who will rig up all of the houses in the buroughs of your denkigai (電気街), the electric town... Akihabara.
+
+What is it really?
+
+It is a small framework based on the akihabara html5 gaming engine with rails developers in mind.  The emphasis is less on a rich gaming experience and more on easily generating a 2d top-down jrpg style map for players to explore.  A lot was cut from the original framework, and entrances to other pages (which actually require a new url) were added to enable a new take on the familiar paradigm of content + links.  
+
+Dependencies
+------
+* rails 3
+* jquery
+
+Setup 
+--------------------
+1. Copy this entire directory into your_project/lib/generators directory
+2. rails generate rpg <whatever_you_want_the_map_to_be_called>
+3. Add in the jquery javascript file in application.rb like so:
+    <%= javascript_include_tag 'jquery' %>
+
+Usage
+----
+* A route will be created at whatever you used for the map name (/map_name) Visiting this will give you a pretty good idea of what the generator created
+* To customize the sprites available, you will want to edit the images at public/images/game/ (by the way: denki guy doesn't have its own image editor.  It's photoshop or pixen to the rescue)
+* To change what sprites are used in the game, public/javascripts/game/resources.js is your friend
+* To change how npcs (and their dialogues) and other large objects such as the house would be added, edit public/javascripts/game/<your_map>/<your_map>_npc.js
+* To change how the less consequential sprites are added to the map, edit public/javascripts/game/<your_map>/<your_map>_map.js 
+* To see a handful of other setting for your map, look at public/javascripts/game/<your_map>/<your_map>_settings.js
+
+Future Features 
+-----------
+* Additional map types that can be autogenerated
+* A standard way of laying out sprites in an image file.  If this was realized, players could take their avatars with them from one denki guy site to another.
+* A menuing extension of the dialogue system that will support decision trees, or even an interaction as complicated buying something from the ubiquitous "shops" that pepper old jrpgs
+* An inventory system that uses cookies and/or a database to store an inventory, preferences, avatars, etc.
+* Text input for less one sided conversations
+* Internationalization in dialogues
+* Akihabara reintegration to support more sophisticated npcs, weapons, hud, audio, and non-rpg style games 
+* Remove reliance on jquery
+* A text parser that will automatically generate text to be formatted for dialogues
+
+If you have any patches, sprites or other ideas to share, I would love to hear them!
+
+Cheers,
+
+-Evan

data/lib/USAGE

@@ -0,0 +1,35 @@
+Description:
+    This generator creates an rpg style html5 game with one map.  The engine is based on the akihabara engine
+
+Example:
+    rails generate rpg my_map
+
+    This will create:
+      create  app/views/game/my_map.html.erb
+      create  app/controllers/game_controller.rb
+      create  public/javascripts/game/akihabara/gamecycle.js
+      create  public/javascripts/game/akihabara/gbox.js
+      create  public/javascripts/game/akihabara/help.js
+      create  public/javascripts/game/akihabara/iphopad.js
+      create  public/javascripts/game/akihabara/tool.js
+      create  public/javascripts/game/akihabara/toys.js
+      create  public/javascripts/game/akihabara/trigo.js
+      create  public/javascripts/game/game.js
+      create  public/javascripts/game/init_game.js
+      create  public/javascripts/game/resources.js
+      create  public/javascripts/game/my_map/my_map.js
+      create  public/javascripts/game/my_map/my_map.js
+      create  public/javascripts/game/my_map/my_map.js
+      create  public/javascripts/game/my_map/my_map.js
+      create  public/images/game/font.png
+      create  public/images/game/cels.png
+      create  public/images/game/akihabara/8x8s.png
+      create  public/images/game/akihabara/buttons.png
+      create  public/images/game/akihabara/debugfont.png
+      create  public/images/game/akihabara/dpad.png
+      create  public/images/game/akihabara/dpad320.png
+      create  public/images/game/akihabara/fontbig.png
+      create  public/images/game/akihabara/padbg.png
+       route  match 'my_map' => 'game#my_map', :as => 'my_map'
+      create  public/javascripts/jquery.js
+

data/lib/rpg_generator.rb

@@ -0,0 +1,103 @@
+class RpgGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+ 
+  def create_html_file
+    create_file "app/views/game/#{file_name}.html.erb" do
+      " <%= javascript_include_tag 'game/#{file_name}/#{file_name}_settings' %>
+        <%= javascript_include_tag 'game/akihabara/gbox' %>
+        <%= javascript_include_tag 'game/akihabara/iphopad' %>
+        <%= javascript_include_tag 'game/akihabara/trigo' %>
+        <%= javascript_include_tag 'game/akihabara/toys' %>
+        <%= javascript_include_tag 'game/akihabara/help' %>
+        <%= javascript_include_tag 'game/akihabara/tool' %>
+        <%= javascript_include_tag 'game/akihabara/gamecycle' %>
+
+        <%= javascript_include_tag 'game/resources' %>
+        <%= javascript_include_tag 'game/#{file_name}/#{file_name}_map' %>
+        <%= javascript_include_tag 'game/#{file_name}/#{file_name}_npc' %>
+        <%= javascript_include_tag 'game/init_game' %>
+        <%= javascript_include_tag 'game/#{file_name}/#{file_name}' %>
+        <%= javascript_include_tag 'game/game' %>
+      "
+    end
+  end
+
+  def create_game_controller
+    copy_file "game_controller.rb", "app/controllers/game_controller.rb"
+  end
+
+  def include_akihabara_framework
+    copy_file "gamecycle.js", "public/javascripts/game/akihabara/gamecycle.js"
+    copy_file "gbox.js", "public/javascripts/game/akihabara/gbox.js"
+    copy_file "help.js", "public/javascripts/game/akihabara/help.js"
+    copy_file "iphopad.js", "public/javascripts/game/akihabara/iphopad.js"
+    copy_file "tool.js", "public/javascripts/game/akihabara/tool.js"
+    copy_file "toys.js", "public/javascripts/game/akihabara/toys.js"
+    copy_file "trigo.js", "public/javascripts/game/akihabara/trigo.js"
+  end
+
+  def create_game_javascripts
+    copy_file "game.js", "public/javascripts/game/game.js"
+    copy_file "init_game.js", "public/javascripts/game/init_game.js"
+    copy_file "resources.js", "public/javascripts/game/resources.js"
+  end
+
+  def create_level_javascripts
+    copy_file "level_template.js", "public/javascripts/game/#{file_name}/#{file_name}.js"
+    copy_file "map_template.js", "public/javascripts/game/#{file_name}/#{file_name}_map.js"
+    copy_file "npc_template.js", "public/javascripts/game/#{file_name}/#{file_name}_npc.js"
+    copy_file "settings_template.js", "public/javascripts/game/#{file_name}/#{file_name}_settings.js"
+  end
+
+  def add_image_files
+    copy_file "font.png", "public/images/game/font.png"
+    copy_file "cels.png", "public/images/game/cels.png"
+  end
+  
+  def add_akihabara_image_files
+    copy_file "8x8s.png", "public/images/game/akihabara/8x8s.png"
+    copy_file "buttons.png", "public/images/game/akihabara/buttons.png"
+    copy_file "debugfont.png", "public/images/game/akihabara/debugfont.png"
+    copy_file "dpad.png", "public/images/game/akihabara/dpad.png"
+    copy_file "dpad320.png", "public/images/game/akihabara/dpad320.png"
+    copy_file "fontbig.png", "public/images/game/akihabara/fontbig.png"
+    copy_file "padbg.png", "public/images/game/akihabara/padbg.png"
+  end
+  def add_route_for_map
+    route ("match '#{file_name}' => 'game##{file_name}', :as => '#{file_name}'")
+  end
+
+  def add_jquery
+    copy_file "jquery.js", "public/javascripts/jquery.js"
+  end
+  
+  def exit_message 
+    puts "
+    
+    Great success!  The files you want to mess with most are probably: 
+    public/javascripts/game/#{file_name}/#{file_name}_map.js
+    public/javascripts/game/#{file_name}/#{file_name}_settings.js
+    public/javascripts/game/#{file_name}/#{file_name}_npc.js
+    public/javascripts/game/resources.js
+
+    ==================================WARNING================================== 
+
+
+    This will not work if you are using prototype
+    A line such as '<%= javascript_include_tag :defaults %>' in application.html.erb will yield unexpected, weird behavior 
+    (mostly just breaking the page as far as I know so far).
+
+    A Jquery file has been added.  You will need to include this somewhere in your application layout or view like so: 
+    <%= javascript_include_tag 'jquery' %>
+    To fully convert to jquery from prototype, you may need to swap out your rails.js with something such as the file found at https://github.com/rails/jquery-ujs/tree/master/src
+
+    ===========================Warning over... sorry 'fai scurred you=======
+
+    Anyways, I'll be at github.com/evanburchard if you have any questions, bug reports, or feature requests.
+
+    Have fun, 
+    -Evan
+    "
+  end
+
+end

data/lib/templates/game.css

@@ -0,0 +1,3 @@
+BODY { 
+  -webkit-user-select:none; margin:0px
+}

data/lib/templates/game.js

@@ -0,0 +1,165 @@
+var tilemaps;
+var maingame;
+var dialogues;
+var faces;
+
+function leave_page(website) {				
+    $('canvas').fadeOut('slow', function() {
+      window.location = website;
+      maingame.gameIsHold = true;
+    });
+}
+
+function go() {
+
+  gbox.setGroups(["background","player","bonus","foes","walls","playerbullets","foesbullets","sparks","foreground","gamecycle"]);
+  // player, walls, bullets and foes are under z-index layer
+  gbox.setRenderOrder(["background",gbox.ZINDEX_LAYER,"sparks","foreground","gamecycle"]);
+
+  maingame=gamecycle.createMaingame("gamecycle","gamecycle");	
+
+  // No level intro animation
+  maingame.gameIntroAnimation=function() { return true; }
+
+  // Change level
+  maingame.changeLevel=function(level) {
+    // Cleanup the level
+    gbox.trashGroup("playerbullets");
+    gbox.trashGroup("foesbullets");
+    gbox.trashGroup("foes");
+    gbox.trashGroup("bonus");
+    gbox.trashGroup("walls");
+    gbox.purgeGarbage(); // Since we're starting, we can purge all now
+    level={level:"yard"}; 
+    tilemaps.current=level.level;
+    gbox.createCanvas("tileslayer",{w:tilemaps[tilemaps.current].w,h:tilemaps[tilemaps.current].h});
+    gbox.blitTilemap(gbox.getCanvasContext("tileslayer"),tilemaps[tilemaps.current]);
+    toys.topview.spawn(gbox.getObject("player","player"),{x:player_starts_at["x"],y:player_starts_at["y"]});
+    tilemaps[tilemaps.current].addObjects();
+  }
+
+  maingame.initializeGame= init_game;
+
+  // Changes a tile in the map. It also adds smoke if asked.
+  maingame.setTileInMap=function(x,y,tile) {
+    help.setTileInMap(gbox.getCanvasContext("tileslayer"),tilemaps[tilemaps.current],x,y,tile);
+  }
+
+
+  // Starts a dialogue
+  maingame.startDialogue=function(id,pause) {
+    gbox.addObject({
+      group:"foreground",
+      id:"dialogue",
+      dialogueToRead:id,
+      pause:1+(pause==null?0:1), // Pauses a dialog for a while. Is important to wait a frame very time to cancel the last "b" key press (for interacting, for example)
+        initialize:function() {
+          gbox.getObject("player","player").doPause(true); // First pause the player
+        },
+      blit:function() {
+             if (this.pause)
+      this.pause--;
+             else if (toys.dialogue.render(this,"dialogue",dialogues[this.dialogueToRead])) { // If the dialogue is ended
+               gbox.getObject("player","player").doPause(false); // Unpause the player
+               gbox.trashObject(this); // Trash the dialogue itself.
+             }
+           }
+    });
+  }
+
+  // Add a still object. Are sprites that supports the z-index (houses, trees.) You can walk around these objects
+  maingame.addBlock=function(x,y,tileset,frame) {
+    gbox.addObject({
+      group:"walls",
+    tileset:tileset,
+    zindex:0, // Needed for zindexed objects
+    x:x,
+    y:y,
+    frame:frame,
+
+    initialize:function() {
+      toys.topview.initialize(this); // Any particular initialization. Just the auto z-index
+    },
+    blit:function() {
+           if (gbox.objectIsVisible(this)) {
+             // Then the object. Notes that the y is y-z to have the "over the floor" effect.
+             gbox.blitTile(gbox.getBufferContext(),{tileset:this.tileset,tile:this.frame,dx:this.x,dy:this.y+this.z,camera:this.camera,fliph:this.fliph,flipv:this.flipv});
+           }
+         }
+
+    });
+  }
+
+  // Add a npc (Not Playing Charachter)
+  maingame.addNpc=function(x,y,still,dialogue,questid,talking,has_shadow) {
+    // An easy way to create an NPC.
+    if (has_shadow==true){
+      var where_shadow = 0;
+    }
+    else {
+      var where_shadow = 1;
+    };
+    gbox.addObject({
+      questid:questid,
+      group:"walls",
+      tileset:"npc",
+      zindex:0, // Needed for zindexed objects
+      x:x,
+      y:y,
+      myDialogue:dialogue,
+      iamTalking:false,
+      shadow:{tileset:"shadows",tile:where_shadow},
+      frames:{
+        still:{ speed:6, frames:still },
+      talking:{ speed:6, frames:(talking==null?still:talking) }
+      },
+
+      doPlayerAction:function(sw) {
+                       this.iamTalking=true; // go in talking mode
+                       maingame.startDialogue(this.myDialogue); // Starts its dialogue. Is another object because of z-index
+                     },
+
+      initialize:function() {
+                   toys.topview.initialize(this); // Any particular initialization. Just the auto z-index
+                 },
+
+      first:function(by) {
+              this.counter=(this.counter+1)%12;
+
+              if (this.iamTalking) {
+                this.frame=help.decideFrame(this.counter,this.frames.talking);
+                if (!gbox.getObject("foreground","dialogue")) {// Check if the dialogue ended
+                  this.iamTalking=false; // Stop talking
+                  if ((this.questid!=null)&&(!tilemaps.queststatus[this.questid])) {
+                    tilemaps.queststatus[this.questid]=true; // If related to a quest, the quest is marked as done
+                    maingame.addQuestClear();
+                  }
+                }
+              } else
+                this.frame=help.decideFrame(this.counter,this.frames.still);
+            },
+
+      blit:function() {
+             if (gbox.objectIsVisible(this)) {
+               // Shadowed object. First draws the shadow...
+               gbox.blitTile(gbox.getBufferContext(),{tileset:this.shadow.tileset,tile:this.shadow.tile,dx:this.x,dy:this.y+this.h-gbox.getTiles(this.shadow.tileset).tileh+4,camera:this.camera});
+               // Then the object. Notes that the y is y-z to have the "over the floor" effect.
+               gbox.blitTile(gbox.getBufferContext(),{tileset:this.tileset,tile:this.frame,dx:this.x,dy:this.y+this.z,camera:this.camera,fliph:this.fliph,flipv:this.flipv});
+             }
+           }
+
+    });
+  }
+  gbox.go();		  
+}
+
+window.addEventListener('load', function () {
+  help.akihabaraInit(page_title);
+  gbox.setCallback(go);
+
+  loadResources();
+
+  gbox.loadAll();
+}, false);
+
+

data/lib/templates/game_controller.rb

@@ -0,0 +1,2 @@
+class GameController < ApplicationController 
+end

data/lib/templates/gamecycle.js

@@ -0,0 +1,124 @@
+// ---
+// Copyright (c) 2010 Francesco Cottone, http://www.kesiev.com/
+// ---
+	
+	var gamecycle={
+		createMaingame:function(id,group) {
+		return gbox.addObject({
+		  	id:id,
+		  	group:group,
+		  	counter:0,
+		  	difficulty:0,
+		  	
+		  	step:100,
+		  	isready:false,
+		  	
+		  	hud:{},
+		  	
+		  	
+		  	// Level intro animation
+		  	
+		  	gameIntroAnimation:function(reset) {
+		 	 },
+		 	 
+		  	// game title animation
+		  	gameTitleIntroAnimation:function(reset) {
+		  	},
+		  	
+		  
+		  	// CHECK
+		  	
+		  	gameIsHold:function() { // Use this clause to check collision and kill player: if true the level is changing
+		  		return (this.step==400)||(this.step==401);
+		  	},
+		  	
+		  	// PRIVATES
+		  	
+		  	setStep:function(st) {
+		  		this.step=st;
+		  		this.isready=false;
+		  	},
+		  	
+		  	_resetGroups:function() {
+		  		var g=gbox.getGroups();
+		  		for (var i=0;i<g.length;i++)
+		  			if (g[i]!=this.group) gbox.clearGroup(g[i]);
+				gbox.soloGroup(this.group);
+		  	},
+
+		  	stepIsReady:function() { this.isready=true; },
+		  	blit:function() {
+		  		var ok=false;
+		  		switch (this.step) {
+		  			case 100:
+		  			case 102: { // Press Start / Menu
+		  				if (!this.isready&&(this.step==100)) {
+		  					this._resetGroups();
+							this.gameTitleIntroAnimation(true);
+		  				}
+		  				this.gameTitleIntroAnimation(false);
+		  				switch (this.step) {
+		  					case 100: { // Press to start
+		  						if (!this.isready) {
+		  							this.stepIsReady();
+		  						}
+		  						this.setStep(102);
+		  						break;
+		  					}
+		  					case 102: { // Fader
+		  						if (!this.isready) {
+		  							this._resetGroups();
+		  							toys.resetToy(this,"fadeout");
+		  							this.stepIsReady();
+		  						}
+                  this.setStep(200);
+		  						break;
+		  					}
+		  					break;
+		  				}
+		  				break;
+		  			}
+		  			case 200:// Game intro animation
+		  			
+		  			case 300:// Start game
+		  			
+		  			
+
+		  			{ // Game playing
+		  				if (!this.isready) {
+		  					switch (this.step) {
+		  						case 200: { // Game intro
+		  							toys.resetToy(this,"fadein");
+		  							this.level=null;
+		  							this._nextlevel=null;
+		  							this.hud=toys.ui.hud("maingamehud");
+		  							
+		  							this.initializeGame();
+		  							this.gameIntroAnimation(true);
+		  							
+		  							break;
+		  						}
+		  						case 300: {
+		  							// Game start
+		  							gbox.playAllGroups();
+		  							this.changeLevel(this._nextlevel);
+		  						}
+		  					}
+		  					this.stepIsReady();
+		  				}
+		  				
+		  				switch (this.step) {
+		  					case 200: { // Game intro
+		  						if (this.gameIntroAnimation(false)) this.setStep(300);
+		  						break;
+		  					}
+		  				}
+		  				
+		  				this.hud.blit();
+		  				break;
+		  			}
+		  		}
+		  	}
+		  });
+		 }
+		}