Skip to content

Commit 8cb3f6f

Browse files
authored
Updated readme
1 parent 3e75160 commit 8cb3f6f

1 file changed

Lines changed: 55 additions & 2 deletions

File tree

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
1-
# hashlips_art_engine
2-
HashLips Art Engine is a tool used to create multiple different instances of artworks based on provided layers.
1+
# Welcome to HashLips
2+
3+
All the code in these repos was created and explained by HashLips on the main YouTube channel.
4+
5+
To find out more please visit:
6+
7+
[HashLips YouTube](https://www.youtube.com/channel/UC1LV4_VQGBJHTJjEWUmy8nA)
8+
9+
[HashLips Telegram](https://t.me/hashlipsnft)
10+
11+
[HashLips Twitter](https://twitter.com/hashlipsnft)
12+
13+
[HashLips Website](https://hashlips.online/HashLips)
14+
15+
# HashLips Art Engine
16+
17+
Create generative art by using the canvas api and node js. Before you use the generation engine, make sure you have node.js and yarn installed.
18+
19+
## Installation
20+
21+
```sh
22+
git clone https://github.com/HashLips/hashlips_art_engine.git
23+
24+
yarn add all
25+
```
26+
27+
## Usage
28+
29+
Create your different layers as folders in the 'layers' directory, and add all the layer assets in these directories.
30+
31+
Once you have all your layers, go into `src/config.js` and update the `layersOrder` array to be your layer folders name in order of the back layer to the front layer.
32+
33+
*Example:* If you were creating a portrait design, you might have a background, then a head, a mouth, eyes, eyewear, and then headwear, so your `layersOrder` would look something like this:
34+
35+
```js
36+
const layersOrder = [
37+
{ name: 'Background'},
38+
{ name: 'Ball'},
39+
{ name: 'Eye color' },
40+
{ name: 'Iris' },
41+
{ name: 'Shine' },
42+
{ name: 'Bottom lid' },
43+
{ name: 'Top lid' },
44+
];
45+
```
46+
47+
The `name` of each layer object represents the name of the folder (in `/layers/`) that the images reside in.
48+
49+
Then optionally, update your `format` size, ie the outputted image size, and the `editionSize`, which is the amount of variation outputted.
50+
51+
When you are all ready, run the following command and your outputted art will be in the `build` directory:
52+
53+
```sh
54+
npm run build
55+
```

0 commit comments

Comments
 (0)