burn 0.1.1 → 0.1.2

data/README.md

@@ -1,6 +1,6 @@
-# Burn
+# Burn - a handy toolkit to make .nes application from a single text file written in Ruby DSL
 
-Burn is a free and open source framework that allows you to create 8-bit flavored application using Ruby DSL.
+Burn is a free and open source framework that allows you to create 8-bit flavored application(.nes) using Ruby DSL.
 
 ```ruby
 scene do
@@ -12,7 +12,7 @@ Just like Recipe and Cookbook are DSL for Chef rubygem, this dead simple DSL is
 
 ![Hello-world pic](http://k.swd.cc/burn/resource/screenshot/hello-world.png)
 
-Here is another example. With Fuel DSL, you can even compose background music in 1 minute.
+Here is another example. With Fuel DSL, you can even compose background music in seconds.
 
 ```ruby
 scene do
@@ -108,9 +108,14 @@ Moreover, the executables built with burn will work at [almost any OS](http://en
 Internally, burn contains cc65 executables inside its gemfile and calls them to compile. Main workflow is as follows.
 
 - translate ruby DSL file into c source code
-- compile them to make executable(main.out) by calling cc65
+- compile them to make executable(*.nes) by calling cc65
 - provide emulator(JSNES) for rpaid application development
 
+### Requirements
+
+- Ruby1.9.1+
+- gcc(for windows user this is not required)
+
 ## Getting Started
 
 ### Installation
@@ -122,13 +127,17 @@ Internally, burn contains cc65 executables inside its gemfile and calls them to
 
     echo "scene {label 'hello world'}" > main.rb
     burn -p
-    ls tmp/burn/ | grep main.out
+    ls tmp/burn/ | grep main.nes
+
+`burn -p` command use Firefox primarily. If you'd like to use chrome, type `burn -p -c` instead.
 
-### Burning Another Sample Fuel DSL
+### More Example
 
     git clone https://github.com/remore/burn.git
-    cd burn/example/hello_world
-    burn -p
+    cd burn/example/shooting
+    burn -p -c
+
+`vi main.rb` and customize this simple shooting game if you please.
 
 ## Fuel DSL Methods
 
@@ -491,6 +500,7 @@ TBD(articles about #show, #sprite, #rand and #is_pressed are coming very soon)
 ### Helpful Folks
 
 * Shiru - this project had never been born if I had not found [this article](http://shiru.untergrund.net/articles/programming_nes_games_in_c.htm)
+* My friend from high school - I appreciate him for sending me fine-grained review as always
 
 ### License
 

data/lib/burn/cli.rb

@@ -16,34 +16,99 @@ module Burn
     desc "init", "Initialize environment"
     option :debug, :type => :string, :aliases => '-d', :desc => "Debug mode"
     option :verbose, :type => :boolean, :desc => "Print logs as much as possible", :default => false
-    option :make, :type=>:boolean, :desc=>"Make cc65 binaries from source"
+    option :quick, :type=>:boolean, :desc=>"Make cc65 binaries available without gcc(however unstable. This option is not recommended.)"
     def init
       env = Burn::Util::Os.new
       base_path = "#{File.dirname(__FILE__)}/tools"
       remove_dir base_path+ "/"+env.os_name, :verbose => options[:verbose]
       Burn::Util::Unpack.new.unpack "#{base_path}/#{env.os_name}.tar.gz", base_path
-      if options[:make] then
+      if !env.is_win? && !options[:quick] then
         Burn::Util::Unpack.new.unpack "#{base_path}/src.tar.gz", base_path
         run "/bin/bash #{File.dirname(__FILE__)}/tools/make_exec.sh #{base_path}"
         copy_file "#{base_path}/src/cc65/cc65", "#{base_path}/#{env.os_name}/cc65/bin/cc65", :force => true
         copy_file "#{base_path}/src/ca65/ca65", "#{base_path}/#{env.os_name}/cc65/bin/ca65", :force => true
         copy_file "#{base_path}/src/ld65/ld65", "#{base_path}/#{env.os_name}/cc65/bin/ld65", :force => true
       end
+      say "successfully finished. you've got ready to burn."
     end
 
     desc "make <filename>", "Compile and build application binary from Burn DSL file"
-    option :preview, :type => :boolean, :aliases => '-p', :desc => "Preview .out application right after compilation"
+    option :preview, :type => :boolean, :aliases => '-p', :desc => "Preview .nes application right after compilation"
     option :debug, :type => :string, :aliases => '-d', :desc => "Debug mode"
     option :verbose, :type => :boolean, :desc => "Print logs as much as possible", :default => false
     option :chrome, :type => :boolean, :aliases => '-c',  :desc => "Run emulator on chrome instead of firefox", :default => false
     def make(mainfile=nil)
+      env = Burn::Util::Os.new
       mainfile="main.rb" if mainfile.nil?
       
       if !File.exist?(mainfile) then
         help
       
+      elsif !File.exist?("#{File.dirname(__FILE__)}/tools/#{env.os_name}/cc65/bin/ld65#{".exe" if env.is_win?}") then
+        say <<-EOS
+[ERROR] you are not ready to burn, most probably you haven't execute burn init command yet.
+to fix this, try the following command:
+
+    sudo burn init
+
+EOS
+      
       else
         
+        # init
+        say "running burn v#{VERSION}..."
+        remove_dir "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        empty_directory "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        #directory File.dirname(__FILE__) + "/workspace_default", "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        Burn::Util::Unpack.new.unpack "#{File.dirname(__FILE__)}/tools/workspace_default.tar.gz", "#{@workspace_root}/tmp/burn"
+        
+        # compile and build .nes
+        say "."
+        builder = Builder.new(@workspace_root)
+        builder.verbose options[:verbose]
+        builder.load File.read("#{@workspace_root}/#{mainfile}")
+        builder.generate
+        
+        # Prepare compilers
+        say ".."
+        directory File.dirname(__FILE__) + "/tools/#{env.os_name}", "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
+        
+        # Finally compile
+        say "..."
+        redirect = ""
+        if env.is_win? then
+          command = ""
+          ext = "bat"
+          redirect = " > nul" if !options[:verbose]
+          
+        else
+          command = "/bin/bash "
+          ext = "sh"
+          redirect = " > /dev/null" if !options[:verbose]
+          
+          # Set permissions to execute compilers
+          Dir::glob("#{@workspace_root}/tmp/burn/cc65/bin/*65").each do |f|
+            File.chmod(0777, f)
+          end
+          
+        end
+        run "#{command}#{@workspace_root}/tmp/burn/scripts/compile.#{ext} #{@workspace_root}/tmp/burn #{redirect}", :verbose => options[:verbose]
+        
+        # prepare customized emulator
+        say "...."
+        require 'base64'
+        File.write(
+          "#{@workspace_root}/tmp/burn/release/js/emulator.html", 
+          File.read("#{@workspace_root}/tmp/burn/release/js/emulator.html")
+            .gsub(/__@__TITLE__@__/, mainfile)
+            .gsub(/__@__ROMDATA__@__/,
+              Base64::strict_encode64(
+                File.binread("#{@workspace_root}/tmp/burn/main.nes")
+              )
+            )
+        )
+        copy_file "#{@workspace_root}/tmp/burn/main.nes", "#{@workspace_root}/tmp/burn/release/js/main.nes", :verbose => options[:verbose]
+        
         # used a icon from noun project. Thanks Jenny!
         # http://thenounproject.com/term/fire/24187/
         say <<-EOS
@@ -98,66 +163,28 @@ module Burn
                      `-/oo:                                     
                                                                 
                                                                 
+
+
+Successfully burned. Congratulations!
+
+The executable is available at:
+
+    #{@workspace_root}/tmp/burn/main.nes
+
 EOS
-        # init
-        say "."
-        remove_dir "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
-        empty_directory "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
-        #directory File.dirname(__FILE__) + "/workspace_default", "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
-        Burn::Util::Unpack.new.unpack "#{File.dirname(__FILE__)}/tools/workspace_default.tar.gz", "#{@workspace_root}/tmp/burn"
-        
-        # compile and build .out
-        say ".."
-        builder = Builder.new(@workspace_root)
-        builder.verbose options[:verbose]
-        builder.load File.read("#{@workspace_root}/#{mainfile}")
-        builder.generate
-        
-        # Prepare compilers
-        say "..."
-        env = Burn::Util::Os.new
-        directory File.dirname(__FILE__) + "/tools/#{env.os_name}", "#{@workspace_root}/tmp/burn", :verbose => options[:verbose]
-        
-        # Finally compile
-        say "...."
-        redirect = ""
-        if env.is_win? then
-          command = ""
-          ext = "bat"
-          redirect = " > nul" if !options[:verbose]
-          
+        
+        # run simulator
+        if options[:preview] then
+          play
         else
-          command = "/bin/bash "
-          ext = "sh"
-          redirect = " > /dev/null" if !options[:verbose]
-          
-          # Set permissions to execute compilers
-          Dir::glob("#{@workspace_root}/tmp/burn/cc65/bin/*65").each do |f|
-            File.chmod(0777, f)
-          end
-          
+          say <<-EOS
+try following command to play the app:
+
+    burn play
+
+EOS
+
         end
-        run "#{command}#{@workspace_root}/tmp/burn/scripts/compile.#{ext} #{@workspace_root}/tmp/burn #{redirect}", :verbose => options[:verbose]
-        
-        # prepare customized emulator
-        say "....."
-        require 'base64'
-        File.write(
-          "#{@workspace_root}/tmp/burn/release/js/emulator.html", 
-          File.read("#{@workspace_root}/tmp/burn/release/js/emulator.html")
-            .gsub(/__@__TITLE__@__/, mainfile)
-            .gsub(/__@__ROMDATA__@__/,
-              Base64::strict_encode64(
-                File.binread("#{@workspace_root}/tmp/burn/main.out")
-              )
-            )
-        )
-        copy_file "#{@workspace_root}/tmp/burn/main.out", "#{@workspace_root}/tmp/burn/release/js/main.out", :verbose => options[:verbose]
-        
-        say "Burned."
-        
-        # run simulator
-        play if options[:preview]
       end
     end
     
@@ -169,9 +196,12 @@ EOS
       server.start
     end
     
-    desc "play <file>", "Invoke application simulator."
+    desc "play <file>", "Invoke application simulator."
+    option :debug, :type => :string, :aliases => '-d', :desc => "Debug mode"
+    option :verbose, :type => :boolean, :desc => "Print logs as much as possible", :default => false
+    option :chrome, :type => :boolean, :aliases => '-c',  :desc => "Run emulator on chrome instead of firefox", :default => false
     def play(mainfile=nil)
-      mainfile="main.out" if mainfile.nil?
+      mainfile="main.nes" if mainfile.nil?
       env = Burn::Util::Os.new
       
       # boot up webrick httpserver to download emulator script
@@ -182,6 +212,9 @@ EOS
         run "#{command} &", :verbose => options[:verbose]
       end
       
+      # wait for certain period of time to prevent browser from fetching game url too early
+      sleep 1
+      
       # open up browser
       uri = "http://127.0.0.1:17890/emulator.html"
       browser = options[:chrome] ? "chrome" : "firefox"

data/lib/burn/version.rb

@@ -1,3 +1,3 @@
 module Burn
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: burn
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,3 +136,4 @@ specification_version: 3
 summary: Burn is a free and open source framework that allows you to create 8-bit
   flavored application using Ruby DSL.
 test_files: []
+has_rdoc: