entityjs 0.2.2 → 0.3.0

data/.gitignore

@@ -1,7 +1,8 @@
-Thumbs.db
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-.redcar
+Thumbs.db
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.redcar
+._redcar
 mygame

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--debug

data/README.md

@@ -1,49 +1,170 @@
-# Entity JS
-An HTML5 javascript game engine utlizing the entity-component design. Write highly flexible code in a powerful javascript framework.
-
-[EntityJS Website](http://entityjs.com) | [Demos](http://entityjs.com/demos) | [Tutorials](http://entityjs.com/tutorials) | [API](http://entityjs.com/api)
-
-## What makes this different from other javascript game engines?
-Entity strives to be the most flexible game engine available. We understand no one likes rewritting the same functions and lines of code over and over. So we have developed a solution to this problem and that is the component-entity design. The traditional approach to game engine design is creating a hierarchy of classes. This is infact the **most** tightly coupled design. This creates close coupled classes whos functionality is strictly typed to one class, its not easily portable to other projects, good luck copying that one needed function and as game development progresses classes get bigger and more complex. You will eventually end up with *god-classes* who control most of the game logic.
-
-This becomes a big mess.
-
-In the world of *entity-component* designs. All logic is implemented in a *component*, as big or small as you want. You can then create an *entity* and add/remove components to it. The entity is a live represantation of all its components. With this low coupling of components and entities you can mix and match components together to create powerful functionality yet still portable and robust.
-
-## Directory Structure
-
-* **build** Contains two build commands to compile entityjs code.
-	* **build_min.bat** Will build a minified version for release.
-	* **build_debug.bat** Will build a debug file for testing offline.
-* **lib** Contains two compiled sources *entity.min.js* and *entity.debug.js*
-* **src** Contains source code of *entityjs*
-* **tutorials** Contains simple tutorials and examples.
-
-## Quick Start Guide
-This will take you through some quick steps to display an image on a canvas element.
-
-* Include *entity.min.js* in your html document (All compiled sources can be found in */lib*).
-
-* Initialize the system by calling *re.system.init*.
-
-	`re.system.init('#canvasId');`
-
-* Start the *main loop* of the application. This will refresh the screen and update logic.
-
-	`re.system.start();`
-
-* We now have to load our image *welcome.png*.
-
-	<code>re.load('welcome.png').complete(function(){ });</code>
-
-* Now inside the complete function body we can display the image. *re.entity* creates a new entity with the given components.
-
-	`re.entity('bitmap welcome.png');`
-
-That should now display an image on your canvas. Yes! For more information check out [the website](entityjs.com).
-
-## Future
-* Ruby YUI compiler
-* Level Editor
-* JS Loader
-* More tutorials!
+# EntityJS
+An HTML5 javascript game engine utlizing the entity-component design. Write highly flexible code in a powerful javascript framework.
+
+[EntityJS Website](http://entityjs.com) | [Demos](http://entityjs.com/demos) | [Tutorials](http://entityjs.com/tutorials) | [API](http://entityjs.com/api)
+
+## Version 0.3
+
+Version 0.3 is a major release with many revisions and a brand new ruby gem to work with. You can now type `entityjs new game-name` and a new game will be created. Of course there are more commands, check below.
+
+There is a new directory structure, testing framework, better minifier, better config file and more. This is currently in alpha and most of it doesn't work!
+
+**Warning:** there are many name changes which will break older versions!
+
+## API
+Currently the [API](http://entityjs.com/api) is out of date. It will be updated once version 0.3 is released.
+
+## What makes this different from other javascript game engines?
+Entity strives to be the most flexible game engine available. We understand no one likes rewritting the same functions and lines of code over and over. So we have developed a solution to this problem and that is the component-entity design. The traditional approach to game engine design is creating a hierarchy of classes. This is infact the **most** tightly coupled design. This creates close coupled classes whos functionality is strictly typed to one class, its not easily portable to other projects, good luck copying that one needed function and as game development progresses classes get bigger and more complex. You will eventually end up with *god-classes* who control most of the game logic.
+
+This becomes a big mess.
+
+In the world of *entity-component* designs. All logic is implemented in a *component*, as big or small as you want. You can then create an *entity* and add/remove components to it. The entity is a live represantation of all its components. With this low coupling of components and entities you can mix and match components together to create powerful functionality yet still portable and robust.
+
+## Requirements
+
+You must have at least [Ruby 1.8.1+](http://rubyinstaller.org/).
+
+## Installion
+
+EntityJS is now an easy to install gem. In the terminal type in:
+
+`gem install entityjs`
+
+This will install the latest version of the gem and now you can easily create some games!
+
+
+## Usage
+
+**Warning** at the moment the gemfile is at version 0.2.2 and is **broken**. Wait until version 0.3 to try these commands.
+
+When using these commands make sure you are always in the root directory of your game.
+
+### Creating a New Game
+
+Creating a game is simple, move to any directory and type in:
+
+`entityjs new mygame`
+
+This will create a new game using the default template.
+
+Create a game with a platform template:
+
+`entityjs new mygame platform`
+
+See all available templates:
+
+`entityjs templates`
+
+### Creating a Component
+
+`entityjs comp rock`
+
+This will create a new component called *rock* at scripts/rock.js and will create a test file inside test/rock.js
+
+`entityjs comp display/hero`
+
+This will create a new component in the directory scripts/display.
+
+### Creating a Test
+
+`entityjs test name test1 test1`
+
+Create a test in tests/name_test.js with two test methods.
+
+### Build Game
+
+`entityjs build`
+
+This will minify all entityjs src code and game src code into one file inside /builds
+
+### Running the Game / Tests
+
+Make sure the server is running:
+`entityjs server`
+
+To play visit:
+`localhost:2345`
+
+To run tests visit:
+`localhost:2345/tests`
+
+Assets are located here:
+`localhost:2345/assets/*name`
+
+## Directory Structure
+
+* Assets - Contains all external assets
+  * Images - Add any images here and retrieve them with `re.assets.images`
+  * Sounds - Add any sounds and retrieve them with `re.assets.sounds`
+  * [Custom] - Create any folders or files and they will be available in code.
+  * json, tmx, xml, sounds and images are accepted files.
+
+* Builds - Contains all finished builds
+
+* Scripts - Contains all javascript sources.
+  * Plugins - Contains external scripts from other authors.
+
+* Tests - Contains test files to run in [QUnit](http://docs.jquery.com/QUnit)
+
+* config.yml - Optional, simple configuration.
+* readme.txt - Optional, simple description of the game.
+  
+## Changes In V0.3
+
+* `Inherit()` is now `defaults()`
+* `Extend()` is now `defines()`
+* `Inherit()` on entities is now `def()`
+* `Extend()` on entities is now `attr()`
+
+There are many more name changes, make sure to read the component source code for more information. Also every component has a usage example.
+
+### Short getters and setters
+
+    var tile = re.e('tile');
+    tile.tileX(1); //sets
+    tile.tileX(); //gets
+
+#### Setters can even be used in `attr()`
+
+    tile.attr('tileX', 2); //sets
+  
+#### Setter with multiple parameters
+
+    tile.tile(1, 2); //sets tilex and tiley
+    //or
+    tile.attr('tile', [1,2]); //samething
+  
+### Signals Changed to on/off
+
+* `addSignal()` is now `on()`
+* `removeSignal()` is now `off()`
+* `signal()` is now `trigger()`
+
+## QUnit Testing
+
+All games will now use [QUnit](http://docs.jquery.com/QUnit) as the primary test framework. Its light weight and awesome.
+
+Special methods like `keypress` and `click` are available to simulate user input. Check `localhost:2345/qunit/qunit.input.js` for more information.  
+
+## Tile Map Editor
+
+The awesome [tiled](http://www.mapeditor.org/) map editor is now compatible and can be used in your projects. 
+
+Simply create a new directory in /assets named levels or anything you like to save your maps in. They can accessed in code like so:
+
+    re('level1.tmx')[0]; //assuming the file name is level1.tmx
+    re('level'); //find all levels that are in the /assets/levels directory
+
+If you are still confused create a new platform game and view how the levels are used.
+
+## Quick Start Guide
+First you should install [ruby](http://rubyinstaller.org/) and the [entityjs gem](http://rubygems.org/gems/entityjs). 
+
+Now you can create a new game:
+`entityjs new mygame`
+
+Move into the mygame/ directory and lets play the game:
+`entityjs server`
+
+Open your browser and navigate to `localhost:2345`

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/bin/entityjs

@@ -1,14 +1,24 @@
-#!/usr/bin/env ruby
-
-
-lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
-$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
-
-require 'entityjs'
-require 'entityjs/command'
-
-args = ARGV.dup
-ARGV.clear
-command = args.shift.strip rescue 'help'
-
-Entityjs::Command.run(command, args)
+#!/usr/bin/env ruby
+
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'entityjs'
+
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+code = Entityjs::Command.run(command, args)
+
+case code
+  when 1
+    puts "Command not found"
+  when 2
+    puts "EntityJS game not found"
+    puts "Move inside the root directory"
+  when 3
+    puts "File/Directory exists"
+    
+end

data/entityjs.gemspec

@@ -6,20 +6,26 @@ Gem::Specification.new do |s|
   s.name        = "entityjs"
   s.version     = Entityjs::VERSION
   s.authors     = ["Ben D'Angelo"]
-  s.email       = ["ben.dangelo2@gmail.com"]
+  s.email       = ["ben@entityjs.com"]
   s.homepage    = "http://entityjs.com"
-  s.summary     = %q{A HTML5 Javascript game engine.}
-  s.description = %q{A HTML5 Javascript game engine.}
-
+  s.summary     = %q{Create HTML5 javascript games in EntityJS.}
+  s.description = %q{The EntityJS gem supplies easy to use commands for creating javascript games.}
+  
+  s.license = 'MIT'
+  
   s.rubyforge_project = "entityjs"
-
+  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-
+  
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
-  s.add_runtime_dependency 'uglifier'
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "jasmine"
+  
+  s.add_dependency "sinatra"
+  s.add_dependency 'uglifier'
+  s.add_dependency 'json'
+  s.add_dependency 'cobravsmongoose'
 end

data/lib/entityjs/assets.rb

@@ -0,0 +1,167 @@
+
+module Entityjs
+  
+  class Assets
+    
+    def self.valid_datas
+      ['xml', 'json', 'tmx']
+    end
+    
+    def self.set_vars(contents, tests=false)
+      #read file for changes
+      Config.instance.reload
+      
+      contents = contents.gsub("$WIDTH", Config.instance.width.to_s)
+      contents = contents.gsub("$HEIGHT", Config.instance.height.to_s)
+      contents = contents.gsub("$CANVAS_ID", Config.instance.canvas_id)
+      
+      contents.gsub("$JS", Assets.to_html(tests))
+    end
+    
+    #combine all sources into valid html scripts
+    def self.to_html(tests=false)
+      js = %Q(
+      <script type='text/javascript'>
+      window.addEventListener\('load', function(){
+        #{Assets.to_js}
+        re.version = '#{VERSION}';
+        
+        }\);
+      </script>
+)
+      ent = Dirc.find_entity_src_url(Config.instance.entity_ignore)
+      srcs = Dirc.find_scripts_url(Config.instance.scripts_ignore, Config.instance.scripts_order)
+      
+      if tests
+        tests_src = Dirc.find_tests_url(Config.instance.tests_ignore)
+      else
+        tests_src = []
+      end
+      
+      merg = ent | srcs | tests_src
+      
+      merg.each do |s|
+        js += "\t<script src='#{s}' type='text/javascript'></script>\n"
+      end
+      js
+    end
+    
+    def self.to_js
+      out = %Q(
+      re.load.path = 'assets/';
+      re.assets = {
+        images:#{self.images_to_js},
+        sounds:#{self.sounds_to_js}
+        };
+      re.canvas = '##{Config.instance.canvas_id}';
+      #{self.datas_to_js}
+      )
+    end
+    
+    def self.images_to_js
+      s = self.search('images').collect{|i| "'#{i}'"}.join(', ')
+      
+      "[#{s}]"
+    end
+    
+    def self.sounds_to_js
+      s = self.search('sounds').collect{|i| "'#{i}'"}.join(', ')
+      
+      "[#{s}]"
+    end
+    
+    def self.datas_to_js
+      s = self.search
+      
+      out = ''
+      
+      s.each do |i|
+        
+        basename = File.basename(i)
+        dirname = File.dirname(i)
+        
+        #make singular
+        if dirname[-1] == 's'
+          dirname = dirname[0..-2]
+        end
+        
+        contents = self.file_to_json(Dirc.game_root+'/'+Config.assets_folder+'/'+i)
+        
+        out += %Q(
+        re.e('#{basename} #{dirname}')
+        .attr(#{contents});
+        )
+        
+      end
+      
+      
+      out
+    end
+    
+    def self.data_to_json(data, ext)
+        case ext
+          when /json/
+            return data
+            
+          when /tmx/
+            
+            return ParseTMX.parse(data)
+          
+          when /xml/
+            return ParseXML.parse(data)
+            
+          when /csv/
+            raise 'CSV files are not supported at the moment'
+            
+          when /yml/
+            raise 'YML files are not supported at the moment'
+            
+          else
+            raise "Extension #{ext} not recognized"
+            
+        end
+      
+      return nil
+    end
+    
+    def self.file_to_json(file)
+        contents = IO.read(file)
+        #remove dot from extension
+        ext = File.extname(file).downcase
+        return self.data_to_json(contents, ext)
+    end
+    
+    def self.search(type='*')
+      images_folder = Config.images_folder
+      sounds_folder = Config.sounds_folder
+      assets_folder = Config.assets_folder
+      
+      case type
+        when 'images'
+          return self.find_files(images_folder+'/*').select{|i| i.match(/^*\.(gif|png|jpg|jpeg)$/i)}
+          
+        when 'sounds'
+          return self.find_files(sounds_folder+'/*').select{|i| i.match(/^*\.(mp3|ogg|aac|wav)$/i)}
+          
+        else
+          return self.search_datas
+          
+      end
+      
+    end
+    
+    def self.search_datas
+      datas = self.valid_datas.join('|')
+      return self.find_files("#{Config.assets_folder}/*/*").select{|i| !i.match(/\/(images|sounds)\//i) && i.match(/^*\.(#{datas})$/i)}
+    end
+    
+    def self.find_files(search)
+      Dir[Dirc.game_root+'/'+search].collect do |i|
+        #remove long string
+        i = i.split("assets/").pop
+      end
+    end
+    
+  end
+  
+end

data/lib/entityjs/command.rb

@@ -1,36 +1,61 @@
-
-require 'entityjs/game'
-require 'entityjs/min'
-require 'entityjs/refresh'
-require 'entityjs/comp'
+Dir.glob("#{Entityjs::root}/lib/entityjs/*.rb").each {|f| require f }
+Dir.glob("#{Entityjs::root}/lib/entityjs/*/*.rb").each {|f| require f }
+
+# 0 - ok
+# 1 - command not found
+# 2 - not in game directory
+# 3 - file exists
 
 module Entityjs
   class Command
     
     def self.run(command, args=nil)
-      
-      case command
-        when 'game'
-          Entityjs::Game.generate(command, args[1..-1])
-          puts 'generated game'
-          
-        when 'min'
-          Entityjs::Min.generate(args)
-        
-        when 'refresh'
-          Entityjs::Refresh.generate(args)
-        
-        when 'comp'
-          Entityjs::Comp.generate(args)
-          
-        else
-          puts 'Error enter in one of the following...'
-          puts 'entityjs game [name] [comp]+'
-          puts 'entityjs comp [name]'
-          puts 'entityjs min'
-          puts 'entityjs refresh'
-          
+      
+      case command
+        when /^(new|n)$/
+          return Entityjs::New.generate(args)
+        when 'templates'
+          return Entityjs::Templates.generate(args)
+          
+        when /^(build|b)$/
+          return Entityjs::Build.generate(args)
+        
+        when /^(test|t)$/
+          return Entityjs::Test.generate(args)
+        
+        when /^(comp|c)$/
+          return Entityjs::Comp.generate(args)
+          
+        when /^(server|s)$/
+          return Entityjs::Server.run(args)
+          
+        when /^(font|f)$/
+          return Entityjs::Font.generate(args)
+          
+        when /^(version|v)$/
+          puts 'EntityJS V'+Entityjs::VERSION
+          return 0
+          
+        when /^(help|h)$/
+          puts ""
+          puts '---- Commands ----'
+          puts 'entityjs new [name]'
+          puts 'entityjs new [name] [template]'
+          puts 'entityjs templates'
+          puts 'entityjs comp [name]'
+          puts 'entityjs test [name]'
+          puts 'entityjs test [name] [tests]+'
+          puts 'entityjs font [name] (soon...)'
+          puts 'entityjs build'
+          puts 'entityjs build [name]'
+          puts 'entityjs server'
+          puts 'entityjs help'
+          puts 'entityjs version'
+          return 0
+          
       end
+      
+      return 1
     end
     
   end