cryptopunks 1.2.2 → 2.1.0

data/lib/cryptopunks/tool.rb

@@ -0,0 +1,381 @@
+
+module Cryptopunks
+
+
+class Tool
+  def run( args )
+    Toolii.run( args )
+  end
+end
+
+
+
+class Opts
+  def merge_gli_options!( options = {} )
+    # puts "  update options:"
+    # puts options.inspect
+
+    @file     = options[:file]      if options[:file]
+    @outdir   = options[:dir]       if options[:dir]
+
+    @zoom     = options[:zoom]      if options[:zoom]
+    @offset   = options[:offset]    if options[:offset]
+
+    @seed     = options[:seed]      if options[:seed]
+
+    @verbose = true     if options[:verbose] == true
+  end
+
+
+  def verbose=(boolean)   # add: alias for debug ??
+    @verbose = boolean
+  end
+
+  def verbose?
+    return false if @verbose.nil?   # default verbose/debug flag is false
+    @verbose == true
+  end
+
+  def file()    @file || './punks.png';  end
+  def file?()   @file;  end    ## note: let's you check if file is set (or "untouched")
+
+  def zoom()    @zoom || 1; end
+  def zoom?()   @zoom;  end
+
+  def offset()  @offset || 0; end
+  def offset?() @offset;  end
+
+  def outdir()  @outdir || '.'; end
+  def outdir?() @outdir;  end
+
+  ### use a standard (default) seed - why? why not?
+  def seed()  @seed || 4142; end
+  def seed?() @seed;  end
+
+
+
+end # class Opts
+
+
+
+## note: use gli "dsl" inside a class / namespace
+class Toolii
+   extend GLI::App
+
+   opts = Opts.new
+
+
+program_desc 'punk (or cryptopunk) command line tool'
+
+version Cryptopunks::VERSION
+
+
+desc "Zoom factor x2, x4, x8, etc."
+arg_name 'ZOOM'
+default_value opts.zoom
+flag [:z, :zoom], type: Integer
+
+desc "Start counting at offset"
+arg_name 'NUM'
+default_value opts.offset
+flag [:offset], type: Integer
+
+
+desc "Seed for random number generation / shuffle"
+arg_name 'NUM'
+default_value opts.seed
+flag [:seed], type: Integer
+
+
+
+desc "Output directory"
+arg_name 'DIR'
+default_value opts.outdir
+flag [:d, :dir,
+      :o, :out, :outdir], type: String
+
+
+### todo/check: move option to -t/--tile command only - why? why not?
+desc "True Official Genuine CryptoPunks™ all-in-one composite image"
+arg_name 'FILE'
+default_value opts.file
+flag [:f, :file], type: String
+
+
+
+### global option (required)
+## todo: add check that path is valid?? possible?
+desc '(Debug) Show debug messages'
+switch [:verbose], negatable: false    ## todo: use -w for short form? check ruby interpreter if in use too?
+
+
+
+desc "Flip (vertically) all punk characters in all-in-one punk series composite (#{opts.file})"
+command [:f, :flip] do |c|
+  c.action do |g,o,args|
+    puts "==> reading >#{opts.file}<..."
+    punks = ImageComposite.read( opts.file )
+
+    ## note: for now always assume 24x24
+    cols = punks.width / 24
+    rows = punks.height / 24
+    tile_width = 24
+    tile_height = 24
+
+    phunks = ImageComposite.new( cols, rows,
+                                 width: tile_width,
+                                 height: tile_height )
+
+    punks.each do |punk|
+       phunks << punk.flip_vertically
+    end
+
+    ## make sure outdir exits (default is current working dir e.g. .)
+    FileUtils.mkdir_p( opts.outdir )  unless Dir.exist?( opts.outdir )
+
+    ## note: allways assume .png extension for now
+    basename = File.basename( opts.file, File.extname( opts.file ) )
+    path  = "#{opts.outdir}/#{basename}-flipped.png"
+    puts "==> saving phunks flipped one-by-one by hand to >#{path}<..."
+
+    phunks.save( path )
+    puts 'Done.'
+  end # action
+end # command flip
+
+
+desc "Shuffle all punk characters (randomly) in all-in-one punk series composite (#{opts.file})"
+command [:s, :shuffle] do |c|
+  c.action do |g,o,args|
+    puts "==> reading >#{opts.file}<..."
+    punks = ImageComposite.read( opts.file )
+
+    ## note: for now always assume 24x24
+    cols  = punks.width / 24
+    rows  = punks.height / 24
+    tile_width = 24
+    tile_height = 24
+
+    phunks = ImageComposite.new( cols, rows,
+                                 width: tile_width,
+                                 height: tile_height )
+
+    tiles = cols * rows
+    indexes = (0..tiles-1).to_a
+    srand( opts.seed )     ## note: for new reset **global** random seed and use (builtin) Array#shuffle
+    puts "   using random generation number seed >#{opts.seed}< for shuffle"
+    indexes = indexes.shuffle
+
+    ###
+    # seed 4142 ends in [..., 7566, 828, 8987, 9777]
+    #       333 ends in [..., 6067, 9635, 973, 8172]
+
+
+    indexes.each_with_index do |old_index,new_index|
+       puts "    ##{old_index} now ##{new_index}"
+       phunks << punks[old_index]
+    end
+
+    puts "    all #{tiles} old index numbers (zero-based) for reference using seed #{opts.seed}:"
+    puts indexes.inspect
+
+    ## make sure outdir exits (default is current working dir e.g. .)
+    FileUtils.mkdir_p( opts.outdir )  unless Dir.exist?( opts.outdir )
+
+    ## note: allways assume .png extension for now
+    basename = File.basename( opts.file, File.extname( opts.file ) )
+    path  = "#{opts.outdir}/#{basename}-#{opts.seed}.png"
+    puts "==> saving p(h)unks shuffled one-by-one by hand to >#{path}<..."
+
+    phunks.save( path )
+    puts 'Done.'
+  end # action
+end # command shuffle
+
+
+
+
+
+
+
+desc "Get punk characters via image tiles from all-in-one punk series composite (#{opts.file}) - for IDs use 0 to 9999"
+command [:t, :tile] do |c|
+  c.action do |g,o,args|
+
+    # puts "opts:"
+    # puts opts.inspect
+
+    puts "==> reading >#{opts.file}<..."
+    punks = ImageComposite.read( opts.file )
+
+
+    puts "    setting zoom to #{opts.zoom}x"   if opts.zoom != 1
+
+    ## make sure outdir exits (default is current working dir e.g. .)
+    FileUtils.mkdir_p( opts.outdir )  unless Dir.exist?( opts.outdir )
+
+    args.each_with_index do |arg,index|
+      punk_index = arg.to_i( 10 )  ## assume base 10 decimal
+
+      punk = punks[ punk_index ]
+
+      punk_name = "punk-" + "%04d" % (punk_index + opts.offset)
+
+      ##  if zoom - add x2,x4 or such
+      if opts.zoom != 1
+        punk = punk.zoom( opts.zoom )
+        punk_name << "@#{opts.zoom}x"
+      end
+
+      path  = "#{opts.outdir}/#{punk_name}.png"
+      puts "==> (#{index+1}/#{args.size}) saving punk ##{punk_index+opts.offset} to >#{path}<..."
+
+      punk.save( path )
+    end
+    puts 'Done.'
+  end # action
+end # command tile
+
+
+
+desc 'Generate punk characters from text attributes (from scratch / zero) via builtin punk spritesheet'
+command [:g, :gen, :generate] do |c|
+  c.action do |g,o,args|
+
+    puts "==> generating  >#{args.join( ' + ' )}<..."
+    punk = Image.generate( *args )
+
+    puts "    setting zoom to #{opts.zoom}x"   if opts.zoom != 1
+
+    ## make sure outdir exits (default is current working dir e.g. .)
+    FileUtils.mkdir_p( opts.outdir )  unless Dir.exist?( opts.outdir )
+
+    punk_index = 0    ## assume base 10 decimal
+    punk_name = "punk-" + "%04d" % (punk_index + opts.offset)
+
+    ##  if zoom - add x2,x4 or such
+    if opts.zoom != 1
+      punk = punk.zoom( opts.zoom )
+      punk_name << "@#{opts.zoom}x"
+    end
+
+    path  = "#{opts.outdir}/#{punk_name}.png"
+    puts "==> saving punk ##{punk_index+opts.offset} to >#{path}<..."
+
+    punk.save( path )
+    puts 'Done.'
+  end # action
+end # command generate
+
+
+desc 'Query (builtin off-chain) punk contract for punk text attributes by IDs - use 0 to 9999'
+command [:q, :query] do |c|
+  c.action do |g,o,args|
+
+    # puts "opts:"
+    # puts opts.inspect
+
+    args.each_with_index do |arg,index|
+      punk_index = arg.to_i( 10 )  ## assume base 10 decimal
+
+      puts "==> (#{index+1}/#{args.size}) punk ##{punk_index}..."
+
+      attribute_names = CryptopunksData.punk_attributes( punk_index )
+      ## downcase name and change spaces to underscore
+      attribute_names = attribute_names.map do |name|
+                          name.downcase.gsub( ' ', '_' )
+                        end
+
+      print "  "
+      print attribute_names.join( '  ' )
+      print "\n"
+    end
+    puts 'Done.'
+  end
+end
+
+
+
+desc 'List all punk archetype and attribute names from builtin punk spritesheet'
+command [:l, :ls, :list] do |c|
+  c.action do |g,o,args|
+
+    generator = Cryptopunks.generator
+
+    puts "==> Archetypes"
+    generator.meta.each do |rec|
+      next unless rec.archetype?
+
+      print "  "
+      print "%-30s"  % "#{rec.name} / (#{rec.gender})"
+      print " - #{rec.type}"
+      print "\n"
+    end
+
+    puts ""
+    puts "==> Attributes"
+    generator.meta.each do |rec|
+      next unless rec.attribute?
+
+      print "  "
+      print "%-30s"  % "#{rec.name} / (#{rec.gender})"
+      print " - #{rec.type}"
+      print "\n"
+    end
+
+    puts ""
+    puts "  See github.com/cryptopunksnotdead/punks.spritesheet for more."
+    puts ""
+
+    puts 'Done.'
+  end # action
+end # command list
+
+
+
+pre do |g,c,o,args|
+  opts.merge_gli_options!( g )
+  opts.merge_gli_options!( o )
+
+  if opts.verbose?
+    ## LogUtils::Logger.root.level = :debug
+  end
+
+  ## logger.debug "Executing #{c.name}"
+  true
+end
+
+post do |global,c,o,args|
+  ## logger.debug "Executed #{c.name}"
+  true
+end
+
+
+on_error do |e|
+
+  if opts.verbose?
+    puts e.backtrace
+  end
+
+  if e.is_a?( SystemExit )
+     puts
+     puts "*** error: system exit with status code ( #{e.status} )"
+     exit( e.status )   ## try exit again to make sure error code gets passed along!!!
+  else
+    puts
+    puts "*** error: #{e.message}"
+  end
+
+  ## note: was false    # skip default error handling
+
+  ## note: try true - false WILL SWALLOW exit codes and such
+  ##  - looks like it's still returning 0 (e.g. on unknown option or such)!!!!
+  true
+end
+
+
+### exit run(ARGV)  ## note: use Toolii.run( ARGV ) outside of class
+end   # class Toolii
+end # module Cryptopunks
+
+

data/lib/cryptopunks/version.rb

@@ -2,9 +2,9 @@
 
 module Cryptopunks
 
-  MAJOR = 1
-  MINOR = 2
-  PATCH = 2
+  MAJOR = 2
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/cryptopunks.rb

@@ -7,6 +7,7 @@ require 'csvreader'
 ## extra stdlibs
 require 'digest'     ## move/add to pixelart upstream - why? why not?
 require 'optparse'
+require 'gli'        ## used for command line tool
 
 
 
@@ -22,6 +23,15 @@ end
 require 'cryptopunks/attributes'
 require 'cryptopunks/structs'
 require 'cryptopunks/composite'
+## add old backwards compatible alias
+
+module Cryptopunks
+   class Image
+      Composite = ImageComposite
+   end
+end
+
+
 require 'cryptopunks/dataset'
 
 require 'cryptopunks/colors'
@@ -40,117 +50,137 @@ module Cryptopunks
   end
 
   class Image
-     def self.generate( *values )
-       img = Cryptopunks.generator.generate( *values )
-       ## note: unwrap inner image before passing on to c'tor (requires ChunkyPNG image for now)
-       new( img.image )
-     end
-  end # class Image
-end #  module Cryptopunks
-
-
-
-
-
-
-module Cryptopunks
-class Tool
-  def run( args )
-    opts = { zoom: 1,
-             outdir: '.',
-             file:  './punks.png',
-             offset: 0,
-           }
-
-    parser = OptionParser.new do |cmd|
-      cmd.banner = "Usage: punk (or cryptopunk) [options] IDs"
-
-      cmd.separator "  Mint punk characters from composite (#{opts[:file]}) - for IDs use 0 to 9999"
-      cmd.separator ""
-      cmd.separator "  Options:"
-
-      cmd.on("-z", "--zoom=ZOOM", "Zoom factor x2, x4, x8, etc. (default: #{opts[:zoom]})", Integer ) do |zoom|
-        opts[:zoom] = zoom
-      end
+    def self.generate( *values, style: nil )
+
+#####  add style option / hack - why? why not?
+  if style
+    values =  if style.downcase.index( 'natural') && style.downcase.index( '2')
+                 ["#{values[0]} (N2)"] + values[1..-1]
+              elsif style.downcase[0] == 'n'  ## starting with n - always assume natural(s)
+                 ## auto-add (N) for Natural to archetype
+                 ["#{values[0]} (N)"] + values[1..-1]
+              else
+                puts "!! ERROR - unknown punk style #{style}; sorry"
+                exit 1
+              end
+  end
 
-      cmd.on("-d", "--dir=DIR", "Output directory (default: #{opts[:outdir]})", String ) do |outdir|
-        opts[:outdir] = outdir
-      end
 
-      cmd.on("-f", "--file=FILE", "True Official Genuine CryptoPunks™ composite image (default: #{opts[:file]})", String ) do |file|
-        opts[:file] = file
-      end
+###### hack for black&white
+##   auto-add b&w (black&white) to all attribute names e.g.
+##      Eyes   =>  Eyes B&W
+##      Smile  =>  Smile B&W
+##      ....
+
+     archetype_key =  Generator.normalize_key( values[0] )
+     if archetype_key.end_with?( 'bw' ) ||  ## e.g. B&W
+        archetype_key.end_with?( '1bit')    ## e.g. 1-Bit or 1Bit
+
+        values = [values[0]] + values[1..-1].map do |attribute|
+           attribute_key = Generator.normalize_key( attribute )
+           if ['wildhair'].include?( attribute_key )   ## pass through known b&w attributes by "default"
+               attribute
+           elsif attribute_key.index( "black" )
+               attribute ## pass through as-is
+           else
+               "#{attribute} B&W"
+           end
+       end
+
+       pp values
+    end
 
-      cmd.on("--offset=NUM", "Start counting at offset (default: #{opts[:offset]})", Integer ) do |offset|
-        opts[:offset] = offset
-      end
 
-      cmd.on("-h", "--help", "Prints this help") do
-        puts cmd
-        exit
+    # note: female mouth by default has "custom" colors (not black)
+    #          for every 1/2/3/4 (human) skin tone and for zombie
+    #   auto-"magically" add mapping
+    #
+    #  todo/check/fix - add more "contraints"
+    #    for mapping to only kick-in for "basic" versions
+    #      and not "colored" e.g. golden and such - why? why not?
+    #
+    #    move this mapping here to "post-lookup" processing
+    #   to get/incl. more "meta" attribute info  - why? why not?
+    if archetype_key.index( 'female1' ) ||
+       archetype_key.index( 'female2' ) ||
+       archetype_key.index( 'female3' ) ||
+       archetype_key.index( 'female4' ) ||
+       archetype_key.index( 'zombiefemale' )
+
+      values = [values[0]] + values[1..-1].map do |attribute|
+        attribute_key = Generator.normalize_key( attribute )
+
+        if attribute_key == 'smile' || attribute_key == 'frown'
+          attribute +=   if    archetype_key.index( 'zombiefemale' ) then ' Zombie'
+                         elsif archetype_key.index( 'female1' )      then ' 1'
+                         elsif archetype_key.index( 'female2' )      then ' 2'
+                         elsif archetype_key.index( 'female3' )      then ' 3'
+                         elsif archetype_key.index( 'female4' )      then ' 4'
+                         else
+                           puts "!! ERROR - smile or frown (mouth expression) not supported for archetype:"
+                           pp values
+                           exit 1
+                         end
+        end
+        attribute
       end
     end
 
-    parser.parse!( args )
-
-    puts "opts:"
-    pp opts
-
-    puts "==> reading >#{opts[:file]}<..."
-    punks = Image::Composite.read( opts[:file] )
+       img = Cryptopunks.generator.generate( *values, style: style )
+       ## note: unwrap inner image before passing on to c'tor (requires ChunkyPNG image for now)
+       new( img.image )
+     end # method Image.generate
 
+  end # class Image
 
-    puts "    setting zoom to #{opts[:zoom]}x"   if opts[:zoom] != 1
 
-    ## make sure outdir exits (default is current working dir e.g. .)
-    FileUtils.mkdir_p( opts[:outdir] )  unless Dir.exist?( opts[:outdir] )
+  class Spritesheet
+    ## note: for now class used for "namespace" only
+    def self.find_by( name:, gender: nil, size: nil )  ## return archetype/attribute image by name
+       # note: pass along name as q (query string)
+       Cryptopunks.generator.find( name,
+                                   gender: gender,
+                                   size:   size )
+    end
+  end  # class Spritesheet
+  ## add convenience (alternate spelling) alias - why? why not?
+  SpriteSheet = Spritesheet
+  Sheet       = Spritesheet
+  Sprite      = Spritesheet
+end #  module Cryptopunks
 
-    args.each_with_index do |arg,index|
-      punk_index = arg.to_i
 
-      punk = punks[ punk_index ]
 
-      punk_name = "punk-" + "%04d" % (punk_index + opts[:offset])
+####
+# add CryptoPunksData (off-chain) contract
+require 'cryptopunks/contract/punksdata-assets'
+require 'cryptopunks/contract/punksdata-meta'
+require 'cryptopunks/contract/punksdata-contract'
+CryptoPunksData = CryptopunksData
+PunksData       = CryptopunksData
 
-      ##  if zoom - add x2,x4 or such
-      if opts[:zoom] != 1
-        punk = punk.zoom( opts[:zoom] )
-        punk_name << "x#{opts[:zoom]}"
-      end
 
-      path  = "#{opts[:outdir]}/#{punk_name}.png"
-      puts "==> (#{index+1}/#{args.size}) minting punk ##{punk_index+opts[:offset]}; writing to >#{path}<..."
 
-      punk.save( path )
-    end
 
-    puts "done"
-  end  ## method run
-end # class Tool
 
+require 'cryptopunks/tool'
 
-def self.main( args=ARGV )
-  Tool.new.run( args )
-end
+### add tool convenience helper
+module Cryptopunks
+  def self.main( args=ARGV ) Tool.new.run( args ); end
 end ## module Cryptopunks
 
 
 
 
-### add more built-in (load on demand) design series / collections
-DESIGNS_ORIGINAL = Cryptopunks::DesignSeries.new( "#{Cryptopunks.root}/config/original" )
-DESIGNS_MORE     = Cryptopunks::DesignSeries.new( "#{Cryptopunks.root}/config/more" )
-
-## all designs in one collections
-DESIGNS = {}.merge( DESIGNS_ORIGINAL.to_h,
-                    DESIGNS_MORE.to_h )
-
-
-
 
 ### add some convenience shortcuts
 CryptoPunks = Cryptopunks
 Punks       = Cryptopunks
+## add singular too -why? why not?
+Cryptopunk  = Cryptopunks
+CryptoPunk  = Cryptopunks
+Punk        = Cryptopunks