Skip to content

Commit b95526e

Browse files
ShouqyanShouqyan
Shouqyan
authored and
Shouqyan
committed
Add some more details on readme
1 parent 2d74294 commit b95526e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,28 @@ Create generative art by using the canvas api and node js, feel free to contribu
99
# How to use
1010
## Run the code
1111
1. Run `node index.js`
12-
2. Open the `./output` folder to find your generated images to use as NFTs
12+
2. Open the `./output` folder to find your generated images to use as NFTs, as well as the metadata to use for NFT marketplaces.
1313

1414
## Adjust the provided configuration and resources
1515
### Configuration file
1616
The file `./input/config.js` contains the following properties that can be adjusted to your preference in order to change the behavior of the NFT generation procedure:
1717
- width: - of your image in pixels. Default: `1000px`
1818
- height: - of your image in pixels. Default: `1000px`
1919
- dir: - where image parts are stored. Default: `./input`
20-
- description: - of your generated NFT
20+
- description: - of your generated NFT. Default: `This is an NFT made by the coolest generative code.`
2121
- baseImageUri: - URL base to access your NFTs from. This will be used by platforms to find your image resource. This expects the image to be accessible by it's id like `${baseImageUri}/${id}`.
22-
- startEditionFrom: - number (int) to start naming NFTs from.
23-
- editionSize: - number (int) to end edition at.
24-
- rarityWeights: - allows to provide rarity categories and how many of each type to include in an edition.
22+
- startEditionFrom: - number (int) to start naming NFTs from. Default: `1`
23+
- editionSize: - number (int) to end edition at. Default: `10`
24+
- rarityWeights: - allows to provide rarity categories and how many of each type to include in an edition. Default: `1 super_rare, 4 rare, 5 original`
2525
- layers: list of layers that should be used to render the image. See next section for detail.
2626

2727
### Image layers
28-
The image layers are different parts that make up a full image by overlaying on top of each other. E.g. in this example we start with the eyeball and layer features like the eye lids or iris on top to create the completed and unique eye, which we can then use as part of our NFT collection.
28+
The image layers are different parts that make up a full image by overlaying on top of each other. E.g. in the example input content of this repository we start with the eyeball and layer features like the eye lids or iris on top to create the completed and unique eye, which we can then use as part of our NFT collection.
2929
To ensure uniqueness, we want to add various features and multiple options for each of them in order to allow enough permutations for the amount of unique images we require.
3030

3131
To start, copy the layers/features and their images in a flat hierarchy at a directory of your choice (by default we expect them in `./input/`). The features should contain options for each rarity that is provided via the config file.
3232

33-
After adding the layers, adjust them accordingly in the `config.js` by providing the directory path, positioning and sizes.
33+
After adding the `layers`, adjust them accordingly in the `config.js` by providing the directory path, positioning and sizes.
3434

3535
# Development suggestions
3636
- Preferably use VSCode with the prettifier plugin for a consistent coding style (or equivalent js formatting rules)

0 commit comments

Comments
 (0)