nakor 0.0.8 → 0.0.9

data/README.md

@@ -1,8 +1,10 @@
 # Nakor
 
-Nakor is a Ruby gem for generating a template application for Corona SDK. It creates a template app with a splash screen, a menu with four buttons (Play, Settings, Help, About), and one scene for each of the four buttons. It uses Corona SDK's built-in Storyboard to manage scenes.
+Nakor is a Ruby gem for generating a template application for [Corona SDK](http://www.coronalabs.com). It creates a template app with a splash screen, a menu with four buttons (Play, Settings, Help, About), and one scene for each of the four buttons. It uses Corona SDK's built-in Storyboard to manage scenes.
 
-The generated app also includes [RadLib](https://github.com/radamanthus/radlib), a library of utility Lua functions to support Corona SDK development.
+The generated app also includes [RadLib](http://radamanthus.github.com/radlib/), a library of utility Lua functions to support Corona SDK development.
+
+If you're not familiar with Ruby, or you just want the template code without this wrapper gem, please check out [Corona Game Template](http://radamanthus.github.com/corona-game-template/).
 
 # Installation
 
@@ -13,24 +15,10 @@ The generated app also includes [RadLib](https://github.com/radamanthus/radlib),
 
     nakor generate awesome_app
 
-This will create the *awesome_app* directory in the current directory. To run it in Corona simulator:
+This will create the awesome_app directory in the current directory. To run it in Corona simulator:
 
-    cd awesome_app
     /Applications/CoronaSDK/simulator awesome_app
 
-The generated project directory structure looks like this:
-
-    appname
-      +-- assets
-      +-- appname
-      +-- doc
-      +-- server
-
-The directory structure follows my personal convention for mobile projects:
-
-- All mobile app code is in appname/appname.
-- If this has a server component, the server app source code is in appname/server
-- Game assets (e.g. Illustrator .ai files) are in appname/assets, finished PNGs are copied over to appname/appname because that's where Corona SDK expects them to be.
-- The game design document (yes you should have one) and all other documentation are in appname/doc
-
+# Credits
 
+This code is MIT licensed, see http://developer.coronalabs.com/code/license

data/lib/nakor/generators/app.rb

@@ -2,7 +2,7 @@ require 'thor/group'
 module Nakor
   module Generators
     class App < Thor::Group
-      ASSET_FILES = %W{
+      IMAGE_FILES = %W{
         bk_default.png
         btn_about.png
         btn_about_over.png
@@ -15,24 +15,13 @@ module Nakor
         splash_screen.png
       }
 
-      TEMPLATE_FILES = %W{
-        about.lua
+      SCRIPT_FILES = %W{
         active_record.lua
-        build.settings
-        config.lua
         geometry.lua
-        help.lua
-        init_buttons.lua
         io_ext.lua
-        loadmenu.lua
-        main.lua
-        menu.lua
         middleclass.lua
         orm.lua
-        play.lua
         radlib.lua
-        README
-        settings.lua
         sql.lua
         string_ext.lua
         table_ext.lua
@@ -41,6 +30,20 @@ module Nakor
         underscore.lua
       }
 
+      TEMPLATE_FILES = %W{
+        about.lua
+        build.settings
+        config.lua
+        help.lua
+        init_buttons.lua
+        loadmenu.lua
+        main.lua
+        menu.lua
+        play.lua
+        README
+        settings.lua
+      }
+
       include Thor::Actions
 
       argument :app_name, :type => :string
@@ -55,20 +58,29 @@ module Nakor
 
         # Create the subdirectories
         create_subdirectory app_name
+        create_subdirectory "#{app_name}/images"
+        create_subdirectory "#{app_name}/scripts"
+        create_subdirectory "#{app_name}/scripts/lib"
         create_subdirectory "server"
         create_subdirectory "assets"
         create_subdirectory "doc"
       end
 
-      def copy_source_files
+      def copy_template_files
         TEMPLATE_FILES.each do |template_file|
           template template_file, "#{app_name}/#{app_name}/#{template_file}"
         end
       end
 
-      def copy_asset_files
-        ASSET_FILES.each do |asset_file|
-          copy_file asset_file, "#{app_name}/#{app_name}/#{asset_file}"
+      def copy_script_files
+        SCRIPT_FILES.each do |script_file|
+          copy_file "scripts/lib/#{script_file}", "#{app_name}/#{app_name}/scripts/lib/#{script_file}"
+        end
+      end
+
+      def copy_image_files
+        IMAGE_FILES.each do |image_file|
+          copy_file "images/#{image_file}", "#{app_name}/#{app_name}/images/#{image_file}"
         end
       end
 

data/lib/nakor/generators/corona-game-template/README

@@ -1,34 +1,23 @@
-Corona Game Template version 1.0
-(c) 2011 by Radamanthus Batnag
+This is a template project for building games using [Corona SDK](http://www.coronalabs.com)
 
-This is a template project for building games using Ansca Mobile's Corona SDK (http://www.anscamobile.com/corona/).
+## Note to previous users
 
-This has been tested against Daily Build Version 2011.696 (2011.8.2). It uses the Storyboard API, therefore it will not work with builds that do not have yet the Storyboard API.
+This project has been updated to use the Storyboard API. You can find the old version, which uses Director, in the 1.0 branch.
 
-USAGE
-Out of the box, this is a working Corona project. It includes a splash screen (loadmenu.lua, displays images/splashScreen.png for 1 second) and the following menu buttons:
+# Usage
+
+Out of the box, this is a working Corona project. It includes a splash screen (loadmenu.lua) which displays images/splash_screen.png for 1 second and then displays the main menu (menu.lua) with the following buttons:
 - Play
 - Settings
 - Help
 - About
 
-Note the naming convention for button images: play.png is the button for Play, settings.png for Settings, etc.
-
-The project directory structure follows my personal convention for projects:
-
-appname
-  +-- assets
-  +-- appname
-  +-- doc
-
-- All code is in appname/appname.
-- Game assets (e.g. Illustrator .ai files) are in appname/assets, finished PNGs are copied over to appname/appname because that's where Corona SDK expects them to be.
-- The game design document (yes you should have one) and all other documentation are in appname/doc
+Note the naming convention for button images:
+The buttons for Play are btn_play.png and btn_play_over.png; the buttons for Settings are btn_settings.png and btn_settings_over.png, etc.
 
-CREDITS
+If you have Ruby 1.9.3 installed, my Ruby gem [nakor](http://github.com/radamanthus/nakor) provides an easy command-line interface to generating apps from this template.
 
-The code incorporates the latest version of Director class. Director class was written by Ricardo Rauber (http://developer.anscamobile.com/code/director-class-10)
+# Credits
 
-The code also includes some code adopted from the Ghosts vs. Monsters project by Beebe Games (http://blog.anscamobile.com/2010/12/ghosts-vs-monsters-open-source-game-in-corona-sdk/)
+This code is MIT licensed, see http://developer.coronalabs.com/code/license
 
-This code is MIT licensed, see http://developer.anscamobile.com/code/license

data/lib/nakor/generators/corona-game-template/about.lua

@@ -1,8 +1,8 @@
 local storyboard = require( "storyboard" )
 local scene = storyboard.newScene()
 
-local ui = require "ui"
-local radlib = require "radlib"
+local ui = require "scripts.lib.ui"
+local radlib = require "scripts.lib.radlib"
 
 ---------------------------------------------------------------------------------
 -- BEGINNING OF YOUR IMPLEMENTATION

data/lib/nakor/generators/corona-game-template/help.lua

@@ -1,8 +1,8 @@
 local storyboard = require( "storyboard" )
 local scene = storyboard.newScene()
 
-local ui = require "ui"
-local radlib = require "radlib"
+local ui = require "scripts.lib.ui"
+local radlib = require "scripts.lib.radlib"
 
 ---------------------------------------------------------------------------------
 -- BEGINNING OF YOUR IMPLEMENTATION

data/lib/nakor/generators/corona-game-template/init_buttons.lua

@@ -1,11 +1,11 @@
 _G.buttons = {
   about = {
-    defaultSrc = "btn_about.png",
+    defaultSrc = "images/btn_about.png",
     defaultX = 160,
-    defaultY = 32,	
-    overSrc = "btn_about_over.png",
+    defaultY = 32,
+    overSrc = "images/btn_about_over.png",
     overX = 160,
-    overY = 32,	
+    overY = 32,
     id = "btnAbout",
     text = "",
     font = "Helvetica",
@@ -13,12 +13,12 @@ _G.buttons = {
     emboss = false
   },
   help = {
-    defaultSrc = "btn_help.png",
+    defaultSrc = "images/btn_help.png",
     defaultX = 160,
-    defaultY = 32,		
-    overSrc = "btn_help_over.png",
+    defaultY = 32,
+    overSrc = "images/btn_help_over.png",
     overX = 160,
-    overY = 32,	
+    overY = 32,
     id = "btnHelp",
     text = "",
     font = "Helvetica",
@@ -26,10 +26,10 @@ _G.buttons = {
     emboss = false
   },
   play = {
-    defaultSrc = "btn_play.png",
+    defaultSrc = "images/btn_play.png",
     defaultX = 160,
     defaultY = 32,
-    overSrc = "btn_play_over.png",
+    overSrc = "images/btn_play_over.png",
     overX = 160,
     overY = 32,
     id = "btnPlay",
@@ -39,12 +39,12 @@ _G.buttons = {
     emboss = false
   },
   settings = {
-    defaultSrc = "btn_settings.png",
+    defaultSrc = "images/btn_settings.png",
     defaultX = 160,
-    defaultY = 32,		
-    overSrc = "btn_settings_over.png",
+    defaultY = 32,
+    overSrc = "images/btn_settings_over.png",
     overX = 160,
-    overY = 32,		
+    overY = 32,
     id = "btnSettings",
     text = "",
     font = "Helvetica",

data/lib/nakor/generators/corona-game-template/loadmenu.lua

@@ -13,7 +13,7 @@ end
 function scene:createScene( event )
   local screenGroup = self.view
 
-  local loadingImage = display.newImageRect( "splash_screen.png", 480, 320 )
+  local loadingImage = display.newImageRect( "images/splash_screen.png", 480, 320 )
   loadingImage.x = display.contentWidth/2
   loadingImage.y = display.contentHeight/2
   screenGroup:insert(loadingImage)

data/lib/nakor/generators/corona-game-template/menu.lua

@@ -1,8 +1,8 @@
 local storyboard = require( "storyboard" )
 local scene = storyboard.newScene()
 
-local ui = require "ui"
-local radlib = require "radlib"
+local ui = require "scripts.lib.ui"
+local radlib = require "scripts.lib.radlib"
 
 ---------------------------------------------------------------------------------
 -- BEGINNING OF YOUR IMPLEMENTATION

data/lib/nakor/generators/corona-game-template/play.lua

@@ -1,8 +1,8 @@
 local storyboard = require( "storyboard" )
 local scene = storyboard.newScene()
 
-local ui = require "ui"
-local radlib = require "radlib"
+local ui = require "scripts.lib.ui"
+local radlib = require "scripts.lib.radlib"
 
 ---------------------------------------------------------------------------------
 -- BEGINNING OF YOUR IMPLEMENTATION

data/lib/nakor/generators/corona-game-template/{radlib.lua → scripts/lib/radlib.lua}

@@ -2,19 +2,19 @@
 
 local M = {}
 
-local geometry = require "geometry"
+local geometry = require "scripts.lib.geometry"
 M.geometry = geometry
 
-local ioExt = require "io_ext"
+local ioExt = require "scripts.lib.io_ext"
 M.io = ioExt
 
-local stringExt = require "string_ext"
+local stringExt = require "scripts.lib.string_ext"
 M.string = stringExt
 
-local tableExt = require "table_ext"
+local tableExt = require "scripts.lib.table_ext"
 M.table = tableExt
 
-local timeExt = require "time_ext"
+local timeExt = require "scripts.lib.time_ext"
 M.time = timeExt
 
 local debug = function( msg )

data/lib/nakor/generators/corona-game-template/settings.lua

@@ -1,8 +1,8 @@
 local storyboard = require( "storyboard" )
 local scene = storyboard.newScene()
 
-local ui = require "ui"
-local radlib = require "radlib"
+local ui = require "scripts.lib.ui"
+local radlib = require "scripts.lib.radlib"
 
 ---------------------------------------------------------------------------------
 -- BEGINNING OF YOUR IMPLEMENTATION

data/lib/nakor/version.rb

@@ -1,3 +1,3 @@
 module Nakor
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nakor
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-07 00:00:00.000000000 Z
+date: 2012-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70127996041500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70127996041500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70127996040980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127996040980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70127996040480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127996040480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70127996039980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127996039980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "\n    To create a new Corona SDK game using nakor, just run:\n\n    nakor
   generate awesome_game\n\n    This will create an awesome_game directory in the current
   directory, and copy all corona game template files into it.\n\n    To run the generated
@@ -81,37 +101,38 @@ files:
 - lib/nakor/generators/app.rb
 - lib/nakor/generators/corona-game-template/README
 - lib/nakor/generators/corona-game-template/about.lua
-- lib/nakor/generators/corona-game-template/active_record.lua
-- lib/nakor/generators/corona-game-template/bk_default.png
-- lib/nakor/generators/corona-game-template/btn_about.png
-- lib/nakor/generators/corona-game-template/btn_about_over.png
-- lib/nakor/generators/corona-game-template/btn_help.png
-- lib/nakor/generators/corona-game-template/btn_help_over.png
-- lib/nakor/generators/corona-game-template/btn_play.png
-- lib/nakor/generators/corona-game-template/btn_play_over.png
-- lib/nakor/generators/corona-game-template/btn_settings.png
-- lib/nakor/generators/corona-game-template/btn_settings_over.png
 - lib/nakor/generators/corona-game-template/build.settings
 - lib/nakor/generators/corona-game-template/config.lua
-- lib/nakor/generators/corona-game-template/geometry.lua
 - lib/nakor/generators/corona-game-template/help.lua
+- lib/nakor/generators/corona-game-template/images/bk_default.png
+- lib/nakor/generators/corona-game-template/images/btn_about.png
+- lib/nakor/generators/corona-game-template/images/btn_about_over.png
+- lib/nakor/generators/corona-game-template/images/btn_help.png
+- lib/nakor/generators/corona-game-template/images/btn_help_over.png
+- lib/nakor/generators/corona-game-template/images/btn_play.png
+- lib/nakor/generators/corona-game-template/images/btn_play_over.png
+- lib/nakor/generators/corona-game-template/images/btn_settings.png
+- lib/nakor/generators/corona-game-template/images/btn_settings_over.png
+- lib/nakor/generators/corona-game-template/images/splash_screen.png
 - lib/nakor/generators/corona-game-template/init_buttons.lua
-- lib/nakor/generators/corona-game-template/io_ext.lua
 - lib/nakor/generators/corona-game-template/loadmenu.lua
 - lib/nakor/generators/corona-game-template/main.lua
 - lib/nakor/generators/corona-game-template/menu.lua
-- lib/nakor/generators/corona-game-template/middleclass.lua
-- lib/nakor/generators/corona-game-template/orm.lua
 - lib/nakor/generators/corona-game-template/play.lua
-- lib/nakor/generators/corona-game-template/radlib.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/active_record.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/geometry.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/io_ext.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/middleclass.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/orm.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/radlib.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/sql.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/string_ext.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/table_ext.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/time_ext.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/ui.lua
+- lib/nakor/generators/corona-game-template/scripts/lib/underscore.lua
 - lib/nakor/generators/corona-game-template/settings.lua
 - lib/nakor/generators/corona-game-template/splash_screen.png
-- lib/nakor/generators/corona-game-template/sql.lua
-- lib/nakor/generators/corona-game-template/string_ext.lua
-- lib/nakor/generators/corona-game-template/table_ext.lua
-- lib/nakor/generators/corona-game-template/time_ext.lua
-- lib/nakor/generators/corona-game-template/ui.lua
-- lib/nakor/generators/corona-game-template/underscore.lua
 - lib/nakor/utilities/update_rad_lib.rb
 - lib/nakor/version.rb
 - nakor.gemspec
@@ -136,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: nakor
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Nakor is a gem that encapsulates the corona-game-template project.