burn 0.1.2 → 0.1.3

data/README.md

@@ -1,4 +1,4 @@
-# Burn - a handy toolkit to make .nes application from a single text file written in Ruby DSL
+# Burn - a handy toolkit to make .nes application from Ruby DSL
 
 Burn is a free and open source framework that allows you to create 8-bit flavored application(.nes) using Ruby DSL.
 
@@ -81,12 +81,12 @@ Please visit [our project page](http://k.swd.cc/burn/) for more example.
 * [Getting Started](#getting-started)
     * [Installation](#installation)
     * [Quick Start](#quick-start)
-    * [Burning Sample Fuel DSL](#burning-sample-fuel-dsl)
+    * [More Examples](#more-examples)
 * [Fuel DSL Methods](#fuel-dsl-methods)
     * [Scene](#scene)
-    * [Sound](#sound)
-    * [Music](#music)
     * [Declare](#declare)
+    * [Music](#music)
+    * [Sound](#sound)
 * [Burning Fuel DSL In Action](#burning-fuel-dsl-in-action)
     * [Programming With .rrb(Restricted Ruby) Syntax](#programming-with-rrbrestricted-ruby-syntax)
 * [Notes](#notes)
@@ -125,23 +125,30 @@ Internally, burn contains cc65 executables inside its gemfile and calls them to
 
 ### Quick Start
 
+`burn -p` command use Firefox primarily. If you'd like to use chrome, type `burn -p -c` instead.
+
     echo "scene {label 'hello world'}" > main.rb
     burn -p
     ls tmp/burn/ | grep main.nes
 
-`burn -p` command use Firefox primarily. If you'd like to use chrome, type `burn -p -c` instead.
+### More Examples
 
-### More Example
+Customize example/shooting/main.rb and play with it if you please.
 
     git clone https://github.com/remore/burn.git
     cd burn/example/shooting
     burn -p -c
+     
+    # if you'd like to make executable, simply remove -p option or type burn make
+    burn
+    burn make
+     
+    # you can boot the emulator up whenever you want(without burning Fuel DSL)
+    burn play
 
-`vi main.rb` and customize this simple shooting game if you please.
-
-## Fuel DSL Methods
+## Fuel DSL
 
-Currently following DSL Methods are available. If you are newbie here, kindly visit [project page](http://k.swd.cc/burn/) first to see what you can do with Burn and Fuel DSL.
+Currently following 4 resources are available. Let's take a quick look how we can make 8-bit flavored application without hassle.
 
 * [Scene](#scene)
 * [Sound](#sound)
@@ -150,6 +157,8 @@ Currently following DSL Methods are available. If you are newbie here, kindly vi
 
 ### Scene
 
+Scene resource is a key concept to make any kind of application. This is where you design screen transition, controller event binding and game balance design etc etc..
+
 #### label(string, x=0, y=1)
 
 The label method can be used in a scene to display static string.
@@ -170,6 +179,8 @@ scene do
 end
 ```
 
+![label pic](http://k.swd.cc/burn/resource/screenshot/label.png)
+
 #### fade_in, fade_out
 
 These methods can be used in a scene to fade in or out.
@@ -287,10 +298,12 @@ The color method can be used in a scene to pick a color and set it to specific p
 ```ruby
 scene do
   label "Hello, World!"
-  color :text, :pink, :darker
+  color :text, :green, :lighter
 end
 ```
 
+![color pic](http://k.swd.cc/burn/resource/screenshot/color.png)
+
 #### wait(interval)
 
 The wait method can be used in a scene to pause for certain period of time.
@@ -441,18 +454,152 @@ scene "title" do
 end
 ```
 
+### Declare
+
+Declare resource is essential part of programming with using Scene#main_loop.
+
+If you give Number as shown below, then method name like #frame or #color_flag becomes variable in Scene#main_loop process.
+
+```ruby
+declare do
+  frame 0
+  color_flag 0
+end
+```
+
+If you give String conststs of 8x8 character block just like following example code, then left left-hand member becomes sprite object in Scene#main_loop process.
+
+```ruby
+declare do
+  tile <<-EOH
+11111111
+11222211
+11233211
+11233211
+11233211
+11233211
+11222211
+11111111
+EOH
+end
+```
+
+### Music
+
+This is where burn rubygem compose music for you. The only requirement for you to start to compose music is your favorite text editor.
+
+Music resource can accept only two methods so far, #tempo and #channel.
+
+#### tempo(speed)
+
+The tempo method in a music can be used to set a tempo of a song.
+
+<dl>
+  <dt>speed Symbol</dt>
+  <dd>song speed symbol to set.
+    <table>
+      <tr>
+        <th>Song Speed</th>
+      </tr>
+      <tr><td>:presto</td></tr>
+      <tr><td>:allegro</td></tr>
+      <tr><td>:moderato</td></tr>
+      <tr><td>:andante</td></tr>
+      <tr><td>:adagio</td></tr>
+      <tr><td>:largo</td></tr>
+    </table>
+  </dd>
+</dl>
+
+```ruby
+music "fanfare" do
+  tempo :allegro
+  channel ...
+end
+```
+
+#### channel(instrument)
+
+The channel method in a music can be used to set a channel of the song. Maximum three channels per music can be set.
+
+<dl>
+  <dt>instrument String</dt>
+  <dd>instrument to play.
+    <table>
+      <tr>
+        <th>Instrument</th>
+      </tr>
+      <tr><td>"bass"</td></tr>
+      <tr><td>"piano"</td></tr>
+      <tr><td>"string"</td></tr>
+      <tr><td>"arpeggio"</td></tr>
+      <tr><td>"step"</td></tr>
+      <tr><td>"bell"</td></tr>
+      <tr><td>"acoustic"</td></tr>
+      <tr><td>"guitar"</td></tr>
+      <tr><td>"theremin"</td></tr>
+    </table>
+  </dd>
+</dl>
+
+Notes of the music are described as shown below. 
+
+- Total 61 notes(5 octaves + rest) notes are available.
+    - For instance, available methods are, `#c0`(0 stands for octave), `#ds0`(s stands for flat), `#d0`, `#es0`...
+- `#segno` and `#dal_segno` are available too
+    - This way you can repeat song
+- Each note can take length as their parameter. Here is list of length available
+    - `:sixteenth`, `:eighth`, `:quarter`, `:half`
+    - `:dotted_sixteenth`, `:dotted_eighth`, `:dotted_quarter`, `:dotted_half`
+    - `:triplet_sixteenth`, `:triplet_eighth`, `:triplet_quarter`, `:triplet_half`
+- Each note can take expression parameter as well
+    - `:tenuto`
+    - `:accent`
+    - `:staccato`
+
+With these basic understanding how you can compose song, here is an example of music.
+
+```ruby
+music "sarabande" do
+  tempo :allegro
+  channel "string" do
+    segno
+    d2   :eighth
+    rest :eighth
+    e2   :eighth
+    rest :eighth
+    dal_segno
+  end
+  channel "piano" do
+    segno
+    a3   :dotted_eighth
+    rest :sixteenth
+    g3   :triplet_eighth
+    g3   :triplet_eighth
+    g3   :triplet_eighth
+    dal_segno
+  end
+end
+```
+
 ### Sound
 
-#### duty_cycle(ratio)
+Sound resource can accept only #effect method as of now. Available methods for #effect are shown below.
+
+#### effect
+
+with this block, you can call following method to configure sound setting.
+
+#### 
 
 The duty_cycle method in a sound can be used to set duty cycle type.
 
 <dl>
-  <dt>ratio Symbol</dt>
-  <dd>duty cycle type to set.
+  <dt>duty_cycle(ratio)</dt>
+  <dd>duty cycle symbol to set. It takes :higher by default.
     <table>
       <tr>
-        <th>duty cycle type</th>
+        <th>Duty Cycle Type</th>
         <th>Value</th>
       </tr>
       <tr>
@@ -473,21 +620,29 @@ The duty_cycle method in a sound can be used to set duty cycle type.
       </tr>
     </table>
   </dd>
+  <dt>velocity(level)</dt>
+  <dd>Volume level number of the sound, between 0 and 15. It takes 7 by default.</dd>
+  <dt>envelope_decay(flag), envelope_decay_loop(flag), length_counter_clock(flag)</dt>
+  <dd>It takes either :enable or :disable flag symbol. Disabled by default.</dd>
+  <dt>length(size)</dt>
+  <dd>Length number of the sound effect, between 1 and 254. It takes 16 by default.</dd>
+  <dt>pitch(control)</dt>
+  <dd>Control number of the sound effect, between 0 and 254. (This value is stil uncontrollable so far. Need to improve)</dd>
 </dl>
 
-#### velocity(level)
-
-The velocity method in a sound can be used to set volume level of the sound.
-
-TBD
-
-### Music
-
-TBD
-
-### Declare
-
-TBD
+```ruby
+sound "attack" do
+  effect do
+    duty_cycle 
+    velocity 15
+    envelope_decay :disable
+    length 10
+    pitch 200
+    envelope_decay_loop :disable
+    length_counter_clock :disable
+  end
+end
+```
 
 ## Burning Fuel DSL In Action
 

data/lib/burn/cli.rb

@@ -49,7 +49,7 @@ module Burn
 [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
+    #{"sudo " if !env.is_win?}burn init
 
 EOS
       
@@ -101,6 +101,9 @@ EOS
           "#{@workspace_root}/tmp/burn/release/js/emulator.html", 
           File.read("#{@workspace_root}/tmp/burn/release/js/emulator.html")
             .gsub(/__@__TITLE__@__/, mainfile)
+            .gsub(/__@__AUTHOR__@__/, "anonymous")
+            .gsub(/__@__CREATED__@__/, Time.new.to_s)
+            .gsub(/__@__ROM__@__/, mainfile)
             .gsub(/__@__ROMDATA__@__/,
               Base64::strict_encode64(
                 File.binread("#{@workspace_root}/tmp/burn/main.nes")

data/lib/burn/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: burn
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -136,4 +136,3 @@ 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: