Skip to content

Latest commit

 

History

History
508 lines (308 loc) · 32.5 KB

README.md

File metadata and controls

508 lines (308 loc) · 32.5 KB
Raw

Blend_My_NFTs

Created by Torrin Leonard License Donate stars

Description

Blend_My_NFTs is an open source, free to use Blender add on that enables you to automatically generate thousands of 3D Models, Animations, and Images. This add on's primary purpose is to aid in the creation of large generative 3D NFT collections.

For support, help, and questions, please join our wonderful Discord community: https://discord.gg/UpZt5Un57t

Checkout the newest tutorial on YouTube that goes along with this documentation: https://www.youtube.com/watch?v=SwU4iVy1XpU

This add on was developed to create the This Cozy Place NFT project which is now availabe to mint on ThisCozyStudio.com

0001-0395.1.mov

The video above illustrates the first 10 Cozy Place NFTs generated with Blend_My_NFts.

Official Links:

Website: https://thiscozystudio.com/

Discord: https://discord.gg/UpZt5Un57t

Youtube: https://www.youtube.com/c/ThisCozyStudio

Twitter: https://twitter.com/CozyPlaceNFT

Instagram: https://www.instagram.com/this_cozy_studio/

Reddit: https://www.reddit.com/r/ThisCozyPlace/

Case Studies

This document has a list of projects that use Blend_My_NFTs to help facilitate them in the creation of their collection: https://docs.google.com/document/d/e/2PACX-1vSHZS4GRu8xXDYpVPEaxyBeTzms9yrJEC9IoAcP38_U8x0C1kVrbtNZgh0zUmkzBoZQVwNvBf3ldRij/pub

Donations

Blend_My_NFTs, this readme documenation, YouTube tutorials, live stream Q/As, and the Discord community are all provided for free by This Cozy Studio for anyone to use and access. We only ask in return that you credit this software and kindly share what our team has built. A direct link to the Blend_My_NFTs Github page on your projects website (or equivelant social platform) would sefice. We ask you to share this tool because we feel there are many out there that would benefit from it, our only goal is to help those in need. It warms our hearts that so many people use this add-on.

Any donations to the following methods will be put towards developing Blend_My_NFTs and future related Metaverse/Blockchain projects. This Cozy Studio has big plans for Blend_My_NFTs in 2022 and we value your support!

Crypto Addresses:

  • Cardano: addr1qxzuqz0c32ucga8amwk53unt7vhyf56q73x55aec2lm8esv9cqyl3z4es360mkadfrexhuewgnf5pazdffmns4lk0nqsfylz24

  • Solana: A7NuHB79DKfkdZMvqVzBrYN4NXRqP7LVFjMdVoKRfVmo

  • Ethereum: 0x335408858ce319Cb411090792Ba4BCEE6a2d10CB

  • USDC (ETH Network): 0x335408858ce319Cb411090792Ba4BCEE6a2d10CB

We at This Cozy Studio really appreciate all the support our community has given us, you push us forward and inspire us to accomplish great things. We are nothing without you.

Thank you,

  • This Cozy Studio team

Quick Disclaimer

Blend_My_NFTs works with Blender 3.0.0 on Windows 10 or macOS Big Sur 11.6. Linux is supported, however I haven't had the chance to test this functionality and guarantee this. Any rendering engine works; Cycles, Eevee, and Octane have all been used by the community without issue. This add-on only works in Blender, a Cinima 4D port will be investigated in the future.

Example Files

The YouTube tutorials use three different .blend example files. This repository has all three and includes a readme.md file that outlines which videos use which files and by what date: https://github.com/torrinworx/BMNFTs_Examples

Table of Contents

Setup and Installation

Here are the steps you need to take to get the Blend_My_NFTs add-on installed in Blender:

  1. Click the green Code button at the top of this page.

Screen Shot 2022-02-03 at 4 53 16 PM

  1. From the drop down click Download ZIP. This will download Blend_My_NFTs-main.zip to your Downloads folder:

Screen Shot 2022-02-03 at 5 17 21 PM

  1. Move the Blend_My_NFTs-main.zip file to your desktop:

Screen Shot 2022-02-03 at 4 57 02 PM

  1. Open Blender and navigate to Edit -> Preferences -> Add-ons:

Screen Shot 2022-02-03 at 5 00 27 PM

Screen Shot 2022-02-03 at 5 00 43 PM

  1. Click the Install button:

Screen Shot 2022-02-03 at 5 05 08 PM

  1. In the Blender File View window, navigate to the Blend_My_NFTs-main.zip file downloaded in step 1., select it, then click Install Add-on:

Screen Shot 2022-02-03 at 5 07 16 PM

  1. Navigate back to the Add-ons window in step 4., and search for Blend_My_NFTs:

Screen Shot 2022-02-03 at 5 02 59 PM

  1. Click the Checkbox to enable the Blend_My_NFTs add-on:

Screen Shot 2022-02-03 at 5 22 43 PM 1

Now that Blend_My_NFTs is installed in your instance of Blender you can find the main panel in the 3D View tab in Layout, once you are there tap N on your keyboard to open the side panel:

Screen Shot 2022-02-03 at 5 27 41 PM

Important Terminology

Before you can continue further, there are terms used in this documenation to describe the process of this software. This makes it easier to understand how you need to organize your .blend file to generate NFTs. Refer to this section if you come accross an unfamiliar term.

Let's say you are creating an NFT collection, the artwork is a .png of a person wearing a hat:

  1. Attribute - A part of the .png that can be changed. The idea of a Hat on a man is an Attribute, there are many types of Hats, but the Hat itself I will refer to it as an Attribute.

  2. Variants - These are the types of Hats; Red Hat, Blue Hat, Green Hat, Cat Hat, etc. These can be swapped into the Hat Attribute to create unique .png NFTs.

  3. DNA - A sequence of numbers that determins what Variant from every Attribute to include in a single NFT .png. Blend_My_NFTs creates and stores a uniqe DNA sequence for each NFT you create. These numbers are stored in the NFTRecord.

  4. NFTRecord - The "Ledger" of all DNA for your NFT collection. This will be generated after you create all the Attribtues and Variants that make up your NFT collection in Blender.

  5. Batch - A randomly selected subset of DNA, taken from the NFTRecord. Blend_My_NFTs can split the NFTRecord into multiple Batches; This allows you to render or create NFTs on multiple computers, or at seperate instances in time.

Blender File Organization and Structure

Organizing your NFTs Attributes and Varariants in Blender is essential to generate files with Blend_My_NFTs. Follow the organizational rules below when making your NFT .blend file:

  1. Your .blend file scene must contain a Script_Ignore collection. Make sure the name is exactly Script_Ignore, include the underscore and capitalization.
  • Any objects (Lights, Cameras, Background images, etc.) that stay constant throughout every NFT file are to be placed in this Script_Ignore collection. Script_Ignore may contain sub collections and all naming conventions are not required withing this collection.

  1. Every Attribute is represented by a collection placed directly in the Scene collection. The name of these attribute collections can not contain numbers or the underscore (_) symbol. The name can contain spaces

  2. Every Variant of each Attribute is represented by a collection. These collections are to be placed in the corresponding Attribute colleciton. The naming convention of these Variant collections is as follows:

  • <Name of Variant>_<Order Number>_<Rarity Percentage>
    • Name of Variant ==> Any string/number/symbol combination, must not include the underscore (_) symbol. Can contain spaces.
    • Order Number ==> An incrementing number. Must increment for each Variant added to a given Attribute starting at 1, numbers cannot repeat and must be unique for each Variant. Can only be in a single number format, do not use 001 or 0001 formats.
    • Rarity Percentage ==> A percentage that determins the chance that the given variant will be selected. Must be a number, can contain decimals, cannot contain the percentage (%) symbol. See Notes on Rarity and Weighted Variants section for more details.
  • Each Variant collection can contain everything that makes up an individual Variant; it can contain objects, lights, meshes, planes, and every other object type.

Example of Proper BMNFTs Compatable Blender Scene

Screen Shot 2022-02-06 at 5 40 39 PM

In this example, notice how the main components in Script_Ignore can be any type of object. The collections Body and Arms are both Attribute collections; Silver Body_1_75 and Gold Body_2_25 are Variants of the Body Attribute, and have a 75% and 25% generation chance. Silver Arms_1_75 and Gold Arms_2_25 are Variants of the Arm Attribute and have the same weighted distribution as the Body Variants. Notice how the Variant collections in the Arm Attribute can contain more than one object and object type, this principle can be applied to any Variant collections.

This repository contains three .blend example files that are compatable with Blend_My_NFTs: https://github.com/torrinworx/BMNFTs_Examples

Steps to Generate NFTs

After you have formatted and organized your NFT collection in Blender to the rules outlined above in Blender File Organization and Structure you can now go about generating your NFT collection. By the end of this process you will have a folder continaing the following:

  1. NFT content files; images, animations, or 3D models in any format that you specify.
  2. Json metadata files; one fore each NFT content filem, formatted to the blockchain standard that you set.

Before you get started, open the .blend of your NFT collection and open the side panel of the Layout tab so that Blend_My_NFTs is visible:

Screen Shot 2022-02-06 at 9 53 29 PM

Each Step below is represented by one panel; everything you have to do for that one step, is in the corosponding panel in Blend_My_NFTs.

Step 1. - Create NFT Data

Blend_My_NFTs needs data to understand your .blend file, in this step you will create that data.

  1. Isolate or open the Create NFT Data panel in Blend_My_NFTs:

Screen Shot 2022-02-06 at 9 56 12 PM

  1. Note - Maximum Number Of NFTs: ### is the maximum number of NFTs your collection can contain with it's current number of Attirbutes and Variants. If you need this number to be higher create more Attributes and Variants.

Screen Shot 2022-02-06 at 9 59 42 PM

  1. Set the name of your NFT collection in the NFT Name: text field:

Screen Shot 2022-02-06 at 10 01 19 PM

This name will be in the metadata and in the name of each NFT content file.

  1. Set your NFT collection size with the NFT Collection Size field:

Screen Shot 2022-02-06 at 10 03 46 PM

Important: This number must be greater than 0 and less than Maximum Number Of NFTs shown at the top of the Create NFT Data panel.

  1. Set the Save Path of your Blend_My_NFTs Output folder by clicking on the file icon and navigating to a directory:

Screen Shot 2022-02-06 at 10 04 43 PM

Then click the Accept button.

Desktop is recommended for easy access, but any easily accessable directory will do.

  1. Enable or Disable Rarity and Weighted Variants with the checkbox Enable Rarity. For more information on what affect this has on your NFT collection, see Blender File Organization and Structureand Notes on Rarity and Weighted Variants.

Screen Shot 2022-02-06 at 10 10 55 PM

  1. Lastly click the Create Data button:

Screen Shot 2022-02-06 at 10 12 37 PM

After completeing the Create NFT Data step, you should have the following files and folders located at the Save Path set in step 6. above;

  • Blend_My_NFTs Outuput folder. A directory that contains all output files from Blend_My_NFTs.
    • NFT_Data folder. This contains the following NFTRecord.json and Batch#.json files.
      • NFTRecord.json file. A ledger that contains the NFT DNA of your collection.
      • Batch_Data folder. Contains all Batch#.json files.
        • Batch#.json files. Smaller chuncks of the NFTRecord.json that contain unique DNA.
    • Generated NFTs folder. This directory will be empty, but is where your NFT content files will be exported to. once you've completed Step 2. Generate NFTs.

Step 2. - Generate NFTs

In this step, you will select the types of NFT content files you wish to generate, as well as the formats you want them in. You will then generate these files in batches, or all at once.

  1. Isolate or open the Generate NFTs panel in Blend_My_NFTs:

Screen Shot 2022-02-06 at 10 22 35 PM

  1. Check the NFT content files you wish to generate (you can select more than one):

Screen Shot 2022-02-06 at 10 37 42 PM

  • If you check Image, choose the file format you want the NFT content files to be exported as from the Image drop-down:

Screen Shot 2022-02-06 at 10 55 28 PM

  • .png --> Exports image as .png

  • .jpeg --> Exports image as .jpeg

  • If you check Animation, choose the file format you want the NFT content files to be exported as from the Animation drop-down:

Screen Shot 2022-02-06 at 10 47 49 PM

  • .avi (AVI_JPEG) --> Exports animations in AVI_JPEG encoding to .avi file format. See Blender API for more information.

  • .avi (AVI_RAW) --> Exports animations in AVI_RAW encoding to .avi file format. See Blender API for more information.

  • .mkv (FFMPEG) --> Exports animations in FFMPEG Blender default encoding and container to .mkv file format. See Blender API for more information.

  • If you check 3D Model, choose the file format you want the NFT content files to be exported as from the 3D Model drop-down:

Screen Shot 2022-02-06 at 10 40 10 PM

  • .glb --> Exports .glb 3D models
  • .gltf + .bin + textures --> Exports .gltf 3D models with seperated textures
  • .gltf --> Exports .gltf 3D models with embeded textures
  • .fbx --> Exports .fbx 3D models
  • .obj --> Exports .obj 3D models
  • .x3d --> Exports .x3d 3D models
  • .stl --> Exports .stl 3D models
  • .vox --> Exports .vox MagicVoxel 3D models. Experimental: This file format is still in development and might not work as intended. Important: You must install the voxwritter Blender add-on for this feature to work.
  1. Select number of the Batch you wish to generate in the Batch to Generate feild:

Screen Shot 2022-02-06 at 10 58 56 PM

  1. Click the Generate NFTs Button. This will generate the NFT content files from the Batch set in above step 3:

Screen Shot 2022-02-06 at 11 00 11 PM

  1. To generate the rest of the Batches you have, repeat steps 3. to 4. and increment the Batch To Generate number.

After completeing the Create NFT Data step, you should have the following files and folders located at the Save Path set in Step 1. Create NFT Data above;

  • Blend_My_NFTs Outuput folder. A directory that contains all output files from Blend_My_NFTs.
    • NFT_Data folder. This contains the following NFTRecord.json and Batch#.json files.
      • NFTRecord.json file. A ledger that contains the NFT DNA of your collection.
      • Batch_Data folder. Contains all Batch#.json files.
        • Batch#.json files. Smaller chuncks of the NFTRecord.json that contain unique DNA.
    • Generated NFTs folder. This directory will be empty, but is where your NFT content files will be exported to. once you've completed Step 2. Generate NFTs.
      • Batch#.json folder. There should be one folder for each batch that you generated.
        • Image folder. The folder where all the NFT Image content files are stored for a given Batch#.json.
          • Image files. These images will contain have the name you specified in Step 1. Create Data, an incrementing number, and the file extension you specified above.
        • Animation folder. The folder where all the NFT Animation content files are stored for a given Btach#.json.
          • Animation files. These animations will have the name you specified in Step 1. Create Data, an incrementing number, and the file extension you specified above.
        • 3D Model folder. The folder where all the NFT 3D Model content files are stored.
          • 3D Model files. These 3D models will have the name you specified in Step 1. Create Data, an incrementing number, and the file extension you specified above.
        • BMNFTs_metaData folder.

Step 3. - Refactor Batches & Create MetaData

In this step you will combine the batch files created in Step 2. - Generate NFTs into one cohesive folder that is ready to be uploaded to the blockchain of your choice. This step will also generate the metadata needed for smart contract minting sites.

This step is to be done after you have completely rendered and generated all of your NFT batches; once you complete this step, you cannot undo the changes.

  1. Isolate or open the Refactor Batches & Create MetaData panel in Blend_My_NFTs:

Screen Shot 2022-02-08 at 4 23 32 PM

  1. Check off the metadata templates you wish to generate (You can create more than one):

Screen Shot 2022-02-08 at 4 28 19 PM

For more information on the metadata generated by Blend_My_NFTs and the standards that are followed see Notes on Meta Data and Standards.

  1. Click the Refactor Batches & Create MetaData button:

Screen Shot 2022-02-08 at 4 32 46 PM

  1. Confirm you wish to refactor your batches by clicking the Refactor your Batches? button in the popup dialogue:

Screen Shot 2022-02-08 at 4 34 30 PM

After completeing the Refactor Batches & Create MetaData step, you should have the following files and folders located at the Save Path set in Step 1. Create NFT Data above;

  • Blend_My_NFTs Outuput folder. A directory that contains all output files from Blend_My_NFTs.

    • NFT_Data folder. This contains the following NFTRecord.json and Batch#.json files.

      • NFTRecord.json file. A ledger that contains the NFT DNA of your collection.
      • Batch_Data folder. Contains all Batch#.json files.
        • Batch#.json files. Smaller chuncks of the NFTRecord.json that contain unique DNA.

    • Complete_Collection folder. A refactored version of the Generated NFTs folder, with all batches reordered and refactored and generated metadata templates.

      • Image folder. The folder where all the NFT Image content files are stored.
        • Image files. These images will contain have the name you specified in Step 1. Create Data, an incrementing number, and the file extension you specified above.
      • Animation folder. The folder where all the NFT Animation content files are stored.
        • Animation files. These animations will have the name you specified in Step 1. Create Data, an incrementing number, and the file extension you specified above.
      • 3D Model folder. The folder where all the NFT 3D Model content files are stored.
        • 3D Model files. These 3D models will have the name you specified in Step 1. Create Data, an incrementing number, and the file extension you specified above.
      • BMNFTs_metaData folder.
      • Cardano_metaData folder; will appear if specified in Step 2. above.
        • Cardano_Data_#.json files. Will contain metadata template in Cardano CIP 25 format.
      • Solana_metaData folder; will appear if specified in step 2. above.
        • Solana_Data_#.json files. Will contain metadata template in Solana Metaplex format.
      • ERC721_metaData folder; will appear if specified in Step 2. above.
        • Erc721_Data_#.json files. Will contain metadata template in ERC721 format.

Congratulations!! You now have a complete 3D NFT collection that is ready to upload to the blockchain of your choice!

Common Issues and Problems

  • The most common issues people face are naming convention issues (See Blender File Organization and Structure). People often miss the naming convention on one or two collections and this typically throws up an error. The best way to resolve this is by reviewing the Blender File Organization and Structure standards and go through each collection in your Blender scene.

  • Remember that each Attribute and each Variant are represented by a collection if this is not the case your Max Number of NFTs will be a negative number or 0.

  • If you make ANY changes to your Blender scene, you need to re-Create NFT Data, otherwise Blend_My_NFTs wont be able to recognize the changes.

Notes on Rarity and Weighted Variants

Rarity is a percentage value and accepts fractions like 0.001%, but they must be specified with decimals in the naming (fraction like 1/2 or 3/5 are not permitted in the naming structure). For ease of use the percentages should add up to 100%:

33% + 33% + 33% + 1% = 100% 

Variant 1 = 33% chance
Variant 2 = 33% chance
Variant 3 = 33% chance
Variant 4 = 1% chance

If you have 20 variants with 50 set as the rarity percentage for each, Blend_My_NFTs will add up the percentages then treat the sum as 100%:

50% + 50% + 50% + 50% + 50%....
= 1,000%

Out of 100%:

(50/1,000)*100 = 5% chance of 1 variant

Rarity is dependent on both the number of NFTs you generate, as well as the maximum number of possible combinations of the Attributes and Variants in your .blend file.

This results in the following two scenarios, say, at a fixed number of 10,000 NFTs to generate;

  1. Your .blend file has 1,000,000,000 possible combinations (trust me that's a small number, our collection for This Cozy Place has over 11 Trillion possible combinations). Generating 10,000 will be more representative of the rarity numbers you set as the script will simply have more combinations to choose from.

  2. Your .blend file has 10,000 possible combinations. This means all possible combinations of your NFT will be generated, meaning that no rarity can be taken into account.

This happens for the following reasons:

  1. The rarity is determined pseudo randomly, but is weighted based on each Variants rarity percentage.

  2. The scripts generally prioritize the number of NFTs to generate (maxNFTs) over rarity percentage

This behaviour is a fundamental mathematical result, not an issue with the code. I've researched various ways of creating and enforcing rarity, this is the only way I have found that works. If you have found a better method, feel free to make a pull request explaining it and I'd be happy to review and merge it to the main Github repo for BMNFTs.

.blend file Rarity examples:

  1. With Rarity percentage (50% 50% split)
  Hat <-- Attribute
  |-Green Hat_1_50
  |-Red Hat_2_50
  1. Since it's 50/50 it can also be expressed like this:
  Hat <-- Attribute
  |-Green Hat_1_0
  |-Red Hat_2_0

Leaving the rarity number as 0 will randomly select 1 of the variants you set in your .blend file. Note that this only works if every variant's rarity is set to 0. For an attribute its rarity or random, not both. You can have different attributes, where some are using rarity and others are randomly selected, but you cannot mix these with variants of one attribute.

More complex Rarity Example:

  Hat <-- Attribute
  |-Green Hat_1_24.75
  |-Red Hat_2_24.75
  |-Blue Hat_2_24.75
  |-Orange Hat_2_24.57
  |-Purple Hat_2_0.5
  |-Yellow Hat_2_0.5

In the example above, Green, Red, Blue, and Orange hats all have an equal chance of getting selected. However Purple and Yellow hats will only appear on average 0.5% of the time. We recommend rounding to about 5 decimal places for simplicity, as numbers of more accuracy aren't really needed for NFT collections 10,000 or smaller.

The code that determines rarity can be found the Rarity_Sorter.py.

Calculating Maximum Number of NFTs (Max Combinations)

Mutliply the number of Variants in each Attribute by each other.

Example:

Screen Shot 2022-02-06 at 5 40 39 PM

In the image above there are two Attributes; Body, and Arms. Each attribute has 2 Variants, so in order to find the Maximum Number of NFTs we do the following:

Number of Variants in Arm Attribute = 2 
Number of Variants in Body Attribute = 2 

(Number of Variants in Arm Attribute)*(Number of Variants in Body Attribute) = Maximum Number of NFTs

2*2 = 4

∴ The Maximum Number of NFTs is 4

The formula for this equation can be simplified to the following:

N 1 *N 2 *N 3 *... = Max NFTs

Notes on Meta Data and Standards

Blend_My_NFTs can export Cardano, Solana, and ERC721 formatted metadata templates. After running Refactor Batches & Create MetaData a template will be generated for each NFT you have created; These templates will include properly formated names for each Attribute and Variant that was selected to create that NFT.

Blend_My_NFTs can only provide this information in the templates, you will have to add Policy ID and URL when you upload and mint your NFT collection. For more information on how to do this see I have my NFTs, what next?

Meta Data Template Sources

The list of meta data standard sources used to create the templates:

The Blend_My_NFTs code implementation for the above standards can be found in main>metaData.py.

Meta Data Disclaimer

These meta data templates are based on the common standards for the given blockchain, you will have to modify and fill them in with a script of your own when you mint your NFT collection. These metadata templates are only provided for your convenience and are as accurate to the standards above that I could make them.

I have my NFTs, what next?

Coming soon...