bitgen 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9d23acf3d75011e1eff3f5590cea308f609062716dce4f36fe9a84e16730b34
-  data.tar.gz: 7ef652cb8f0ed2657d9690b730c063792f7dc901bd6ba63dd2772dae90c4988d
+  metadata.gz: 8d2da11669caadb65ebcb6af3a302c732af8b015b30c6c6ef8dc7d19db553b4d
+  data.tar.gz: cac6c0f92e52cb2e8dda34d2d29e1f114bd4109704d1b55404145d4b9c4be318
 SHA512:
-  metadata.gz: d710bbb59d44b5bfb3f69b99d7efe0052b6d732b5baa145059e275ff1e43cbf138b6f8786e491829c9165c889d28c6dc98bc32d0a8a67032f46c543c9b42097f
-  data.tar.gz: 2997033f71ceba39840ef40b5a1bd84dfbedd8c9362903ab171d131ff2fc99aa50ff0b93f11c3db147a7192b821ea03cd206689308ccb41cd62cfaa42606a349
+  metadata.gz: a43a312e44c8a928b41d455ea68e42e86fb24a74ae2ca8bb52f559c93a1039379c075bbd823e059a264b9d463e407abd1ce1eae35fb55cbcad0f7ce7aa2bc09a
+  data.tar.gz: d40be4d2466d90db4975550c8c4330884c72d6bf6a3d91d9265a6f094b30e8e55eb39755a524d69d729d6782515c14abfe2a3fee5feef2041c4ecc2ef1865c21

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+### 0.1.0 / 2023-07-30
 ### 0.0.1 / 2023-07-30
 
 * Everything is new. First release

data/README.md

@@ -12,9 +12,276 @@ bitgen - bitcoin (inscription) generative image machinery incl gen-brc721 & co
 
 ##  Usage
 
-To be done
+### Generative BRC-721 (Gen BRC-721 or GBRC-721)
 
+(historic) ordinal (bitcoin) protocol by [Jerry Fanelli](https://github.com/jerryfane) proposed / published in mid-May 2023
 
+- Generative BRC-721 Proposol - <https://github.com/jerryfane/generative-brc-721>
+- Analytics (Dune) Dashboard -  <https://dune.com/j543/generative-brc-721>
+
+
+note:  Gen BRC-721 is ded. Jerry Fanelli proposed BRC-69 as
+the official successor in July 2023
+BUT yes, [Ordgen / ORC-721](https://github.com/ordbase/generative-orc-721) may be the better (generative) alternative protocol / winner.
+
+
+Let's try some (historic) Gen BRC-721 collections...
+
+
+### Collection №1 - 1000 Ordibots (32x32px)
+
+_The world's first gen-brc-721_
+
+Find the deploy text @ [inscription no 8326719](https://ordinals.com/inscription/b7205d40f3b1b1486567f0d6e53ff2812983db4c03ad7d3606812cd150c64802i0) - May 21, 2023 by Jerry Fanelli.
+
+
+Let's generate some ulta-rare never-before-seen (do-it-yourself) ordibots.
+
+``` ruby
+require 'bitgen'
+
+## step 1: read in the deploy text (incl the base64-encoded generative images)
+gen = Bitgen::Generator.read( './ordibots.json' )
+
+
+## step 2:  generate your images
+bot = gen.generate( accessories: 'antenna',
+                    body: 'gold-oval',
+                    belly: 'chess',
+                    face: 'happy',
+                  )
+
+bot.save( "./bot1.png" )
+bot.zoom( 4 ).save( "./bot1@4x.png" )
+
+
+bot = gen.generate( background: 'bitcoin-orange',
+                    accessories: 'rainbow',
+                    body: 'standard-square',
+                    belly: 'empty',
+                    face: 'unimpressed'
+                  )
+
+bot.save( "./bot2.png" )
+bot.zoom( 4 ).save( "./bot2@4x.png" )
+
+
+bot = gen.generate( background: 'bitcoin-orange',
+                    accessories: 'rainbow',
+                    body: 'black-and-white-triangular',
+                    belly: 'square',
+                    face: 'happy'
+                  )
+
+bot.save( "./bot3.png" )
+bot.zoom( 4 ).save( "./bot3@4x.png" )
+```
+
+resulting in:
+
+![](i/bot1.png)
+![](i/bot2.png)
+![](i/bot3.png)
+
+in 4x:
+
+![](i/bot1@4x.png)
+![](i/bot2@4x.png)
+![](i/bot3@4x.png)
+
+
+If you wonder what categories and names can I use?
+Print  the cheatsheet returned by `Catalog#cheat`.
+
+
+``` ruby
+catalog = Bitgen::Catalog.read( './ordibots.json' )
+puts catalog.cheat
+```
+
+resulting in:
+
+```
+0 - background (4)
+    0 - blue
+    1 - bitcoin-orange
+    2 - brown
+    3 - purple
+1 - accessories (3)
+    0 - antenna
+    1 - none
+    2 - rainbow
+2 - face (7)
+    0 - happy
+    1 - neutral
+    2 - surprised
+    3 - unimpressed
+    4 - angry
+    5 - bored-green
+    6 - bored-red
+3 - body (9)
+    0 - standard-triangular
+    1 - standard-square
+    2 - standard-oval
+    3 - gold-oval
+    4 - black-and-white-square
+    5 - black-and-white-oval
+    6 - black-and-white-triangular
+    7 - gold-square
+    8 - gold-triangular
+4 - belly (3)
+    0 - empty
+    1 - chess
+    2 - square
+```
+
+Now if you wonder what do these look in pixels?
+Export all images (in 1x and 8x) using `Catalog#export` for browsing
+using your local image viewer / file explorer.
+
+``` ruby
+catalog = Bitgen::Catalog.read( './ordibots.json' )
+catalog.export
+```
+
+resulting in:
+
+```
+/ordibots
+ +---0_background
+ |       0_blue.png
+ |       0_blue@8x.png
+ |       1_bitcoin-orange.png
+ |       1_bitcoin-orange@8x.png
+ |       2_brown.png
+ |       2_brown@8x.png
+ |       3_purple.png
+ |       3_purple@8x.png
+ |
+ +---1_accessories
+ |       0_antenna.png
+ |       0_antenna@8x.png
+ |       1_none.png
+ |       1_none@8x.png
+ |       2_rainbow.png
+ |       2_rainbow@8x.png
+ |
+ +---2_face
+ |       0_happy.png
+ |       0_happy@8x.png
+ |       1_neutral.png
+ |       1_neutral@8x.png
+ |       2_surprised.png
+ |       2_surprised@8x.png
+ |       3_unimpressed.png
+ |       3_unimpressed@8x.png
+ |       4_angry.png
+ |       4_angry@8x.png
+ |       5_bored-green.png
+ |       5_bored-green@8x.png
+ |       6_bored-red.png
+ |       6_bored-red@8x.png
+ |
+ +---3_body
+ |       0_standard-triangular.png
+ |       0_standard-triangular@8x.png
+ |       1_standard-square.png
+ |       1_standard-square@8x.png
+ |       2_standard-oval.png
+ |       2_standard-oval@8x.png
+ |       3_gold-oval.png
+ |       3_gold-oval@8x.png
+ |       4_black-and-white-square.png
+ |       4_black-and-white-square@8x.png
+ |       5_black-and-white-oval.png
+ |       5_black-and-white-oval@8x.png
+ |       6_black-and-white-triangular.png
+ |       6_black-and-white-triangular@8x.png
+ |       7_gold-square.png
+ |       7_gold-square@8x.png
+ |       8_gold-triangular.png
+ |       8_gold-triangular@8x.png
+ |
+ \---4_belly
+         0_empty.png
+         0_empty@8x.png
+         1_chess.png
+         1_chess@8x.png
+         2_square.png
+         2_square@8x.png
+```
+
+
+
+### Collection №2 - 20 000 Blooming Flower (80x80px)
+
+Find the deploy text @ [inscription no 17707699](https://ordinals.com/inscription/1a1427e31c91566fe7fb47d7f5c1b2130bea31219a08e1de794d45512319ee61i0) - July 17, 2023.
+
+
+Let's generate some ulta-rare never-before-seen (do-it-yourself) blooming flowers.
+
+``` ruby
+require 'bitgen'
+
+## step 1: read in the deploy text (incl the base64-encoded generative images)
+gen = Bitgen::Generator.read( './blooming-flower.json' )
+
+## step 2:  generate your images
+flower = gen.generate( background: 'new-moon',
+                       window: 'simple-yellow',
+                       table: 'metal',
+                       flowerpot: 'ceramics-red',
+                       rose: 'bud-red',
+                     )
+
+flower.save( "./flower1.png" )
+flower.zoom( 4 ).save( "./flower1@4x.png" )
+
+
+flower = gen.generate( background: 'autumn',
+                       window: 'sliding-yellow',
+                       table: 'wood',
+                       flowerpot: 'ceramics-blue',
+                       rose: 'bud-white',
+                     )
+
+flower.save( "./flower2.png" )
+flower.zoom( 4 ).save( "./flower2@4x.png" )
+
+
+flower = gen.generate(  flowerpot: 'ceramics-red',
+                        rose: 'bud-red',
+                     )
+
+flower.save( "./flower1a.png" )
+flower.zoom( 4 ).save( "./flower1a@4x.png" )
+
+
+flower = gen.generate( flowerpot: 'ceramics-blue',
+                       rose: 'bud-white',
+                     )
+
+flower.save( "./flower2a.png" )
+flower.zoom( 4 ).save( "./flower2a@4x.png" )
+```
+
+resulting in:
+
+![](i/flower1.png)
+![](i/flower2.png)
+![](i/flower1a.png)
+![](i/flower2a.png)
+
+in 4x:
+
+![](i/flower1@4x.png)
+![](i/flower2@4x.png)
+![](i/flower1a@4x.png)
+![](i/flower2a@4x.png)
+
+
+
+That's it for now.
 
 
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'hoe'
 
 Hoe.spec 'bitgen' do
 
-  self.version =   '0.0.1'  ## Pixelart::Module::Bitgen::VERSION
+  self.version =   '0.1.0'  ## Pixelart::Module::Bitgen::VERSION
 
 
   self.summary = "bitgen - bitcoin generative (inscription) image machinery incl. gen-brc721 & co"

data/lib/bitgen.rb

@@ -1,2 +1,124 @@
+require 'pixelart'
+
+
+module Bitgen
+
+class Catalog   ## change/rename to Spritesheet / Atlas / Deploy or such - why? why not?
+  def self.read( path )
+    data = read_json( path  )
+    # pp data
+  
+    meta = {
+       'slug' => data['slug'],
+       'name' => data['name'],
+       'dim'  => data['dim'] 
+    }
+   
+    attributes = {}
+    data['traits'].each do |category_name, h|
+      puts "==> #{category_name} - #{h.size} record(s)..."
+  
+      h.each_with_index do |(name, h), i|
+         puts "   #{i} - #{name} (#{h['name']}):"
+  
+         img = Image.parse_base64(  h['base64'] )
+  
+         cat = attributes[ category_name ] ||= {}
+         cat[ name ] = img
+      end
+    end
+
+  
+    new( meta: meta,
+         attributes: attributes )
+  end
+
+  def initialize( meta: {},
+                  attributes: {} )
+    @meta = meta
+    @attributes = attributes
+  end
+
+  def name() @meta['name']; end
+  def slug() @meta['slug']; end
+  
+  def dim()  @meta['dim']; end
+  def width()  @meta['dim'] ? @meta['dim'][0] : nil; end
+  def height()  @meta['dim'] ? @meta['dim'][1] : nil; end
+
+
+  def categories()  @attributes.keys; end
+  def [](name) @attributes[name]; end
+
+  def cheat  ## print cheat sheet   
+    buf = '' 
+    @attributes.each_with_index do |(category_name, cat),i|
+        buf << "#{i} - #{category_name} (#{cat.size})\n"
+        cat.each_with_index do |(attribute_name, _),j|
+            buf << "    #{j} - #{attribute_name}\n"
+        end
+    end
+    buf
+  end
+
+  def export
+    @attributes.each_with_index do |(category_name, cat),i|
+      puts "==> #{category_name} - #{cat.size} record(s)..."
+      cat.each_with_index do |(attribute_name, img), j|
+        puts "   #{j} - #{attribute_name} (#{img.width}x#{img.height})"
+    
+        path = "./tmp/#{slug}/#{i}_#{category_name}/#{j}_#{attribute_name}"
+        puts path
+
+        img.save( path+".png" )
+        img.zoom(8).save( path+"@8x.png" )
+      end
+    end
+  end # method export
+end  # class Catalog
+
+
+
+class Generator
+  def self.read( path )
+    catalog = Catalog.read( path )
+    new( catalog )
+  end
+
+  attr_reader :catalog
+
+  def initialize( catalog )
+    @catalog = catalog
+  end
+
+  def generate( **kwargs )
+    img = nil
+    kwargs.each do |category, name|
+       cat = @catalog[ category.to_s] 
+       attribute_img = cat[name.to_s]
+ 
+       if attribute_img.nil?
+         puts "!! WARN - attribute >#{name}< in >#{category}< not found; sorry"
+         puts "  availbable options in #{category}:"
+         pp cat.keys
+       end
+ 
+       img = Image.new( attribute_img.width, attribute_img.height )  if img.nil?
+
+       img.compose!( attribute_img )
+    end
+    img
+ end  # method generate
+
+  ################
+  ## more convenience helpers
+  def cheat() @catalog.cheat; end
+
+end  # class Generator
+
+end # module Bitgen
+
+
+
+
 
-puts "hello, bitgen!"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitgen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer