Skip to content

Commit 280e2cb

Browse files
committed
Update readme
1 parent 1275f20 commit 280e2cb

1 file changed

Lines changed: 65 additions & 15 deletions

File tree

README.MD

Lines changed: 65 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
### CC NFT - TOOLBOX
33
![CRYPT-CHEF TOOL BOX](CC-TB.png)
44

5-
## [Download Latest release](https://github.com/CryptChef/nft-toolbox/releases/tag/beta-v0.0.1)
5+
## [Download Latest release](https://github.com/CryptChef/nft-toolbox/releases/tag/v0.0.5-beta)
66

77
**CC - NFT-TOOLBOX** is a tool to manage your all NFT related tasks without coding.
88

@@ -36,6 +36,9 @@ Table of content
3636
- [7. Extra Meta Data](#7-extra-meta-data)
3737
- [8. Hash Image](#8-hash-image)
3838
- [9. Base URI](#9-base-uri)
39+
- [10. Shuffle Layer Configurations](#10-shuffle-layer-configurations)
40+
- [11. Default rarity weight value](#11-default-rarity-weight-value)
41+
- [12. Default rarity weight value](#12-default-rarity-weight-value)
3942
- [Contributing](#contributing)
4043

4144

@@ -106,11 +109,21 @@ nftbox.exe project generate
106109
* It will generate `images` and `json`(metadata) folders
107110

108111
- **Options**
109-
| Option | Default | Description |
110-
| ------- | --------------- | ----------------------------------- |
111-
| path | Excution folder | Project path |
112-
| workers | 1 | Number of parallel process |
113-
| regen | false | Regenerate without change attribues |
112+
| Option | Default |Options | Description |
113+
| ------- | ---------------|--------| ----------------------------------- |
114+
| path | Excution folder| | Project path |
115+
| workers | 1 | | Number of parallel process |
116+
| regen | new |new, all,image,meta| Regenerate without change attribues |
117+
118+
Regenerate only meta data
119+
```
120+
nftbox.exe project generate --regen meta
121+
```
122+
123+
Regenerate only images
124+
```
125+
nftbox.exe project generate --regen image
126+
```
114127

115128
#### 3. View Collection Summary
116129
```
@@ -145,11 +158,17 @@ For compatiblity we use the same configuration format as *HashLips/hashlips_art_
145158
"growEditionSizeTo": 10000,
146159
"layersOrder": [
147160
{
148-
"name": "<Layer Folder Name>"
161+
"name": "<Layer Folder Name>",
162+
"options": {
163+
"displayName": "Ear"
164+
}
149165
}
150166
]
151167
}]
152168
```
169+
You can have options in layers order
170+
171+
1. Display name - this will replace the layer name in metadata.json
153172

154173
#### 2. Incompatible Layers
155174
```json
@@ -165,12 +184,12 @@ For compatiblity we use the same configuration format as *HashLips/hashlips_art_
165184
**Example**
166185
```json
167186
"incompatible": {
168-
"Sunglass*1-01.png": [
169-
"Beard*1-01.png",
170-
"Mouth*1-01.png"
187+
"Sunglass*1-01": [
188+
"Beard*1-01",
189+
"Mouth*1-01"
171190
]}
172191
```
173-
In here you need **Sunglass*1-01.png** not combined with [**Beard*1-01.png**, **Mouth*1-01.png**]
192+
In here you need **Sunglass*1-01** not combined with [**Beard*1-01**, **Mouth*1-01**]
174193

175194
#### 3. Forced Combined Layers
176195
```json
@@ -186,13 +205,13 @@ In here you need **Sunglass*1-01.png** not combined with [**Beard*1-01.png**, **
186205
*Example 1*
187206
```json
188207
"forcedCombinations": {
189-
"Sunglass*1-01.png": [
190-
"Hat*2-01.png",
191-
"Pipe*1-01.png"
208+
"Sunglass*1-01": [
209+
"Hat*2-01",
210+
"Pipe*1-01"
192211
]
193212
}
194213
```
195-
In here you need **Sunglass*1-01.png** with **Hat*2-01.png** and **Pipe*1-01.png**
214+
In here you need **Sunglass*1-01** with **Hat*2-01** and **Pipe*1-01**
196215

197216

198217
#### 4. Project Description
@@ -232,6 +251,37 @@ Set this to `true` if metadata should contain image hash value
232251
"baseURI": "<baseurl>"
233252
```
234253

254+
#### 10. Shuffle Layer Configurations
255+
256+
```json
257+
"shuffleLayerConfigurations": "true|false"
258+
```
259+
260+
When you have multiple layer configurations and you want to shuffle the generated images without order, keep this `true`
261+
262+
263+
#### 11. Default rarity weight value
264+
265+
```json
266+
"defaultRarity":100
267+
```
268+
In here we don't need to keep each trait with ratity value. For that we use this one as the default rarity value.
269+
270+
#### 12. Default rarity weight value
271+
272+
```json
273+
"background": {
274+
"generate": true,
275+
"brightness": "20"
276+
}
277+
```
278+
`"generate": true|false` Enable geneate background image
279+
`"brightness": "<int>"` Change brightness level
280+
281+
282+
283+
284+
235285
Contributing
236286
------------
237287

0 commit comments

Comments
 (0)