You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -9,28 +9,28 @@ Create generative art by using the canvas api and node js, feel free to contribu
9
9
# How to use
10
10
## Run the code
11
11
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.
13
13
14
14
## Adjust the provided configuration and resources
15
15
### Configuration file
16
16
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:
17
17
- width: - of your image in pixels. Default: `1000px`
18
18
- height: - of your image in pixels. Default: `1000px`
19
19
- 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.`
21
21
- 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`
25
25
- layers: list of layers that should be used to render the image. See next section for detail.
26
26
27
27
### 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.
29
29
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.
30
30
31
31
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.
32
32
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.
34
34
35
35
# Development suggestions
36
36
- Preferably use VSCode with the prettifier plugin for a consistent coding style (or equivalent js formatting rules)
0 commit comments