Skip to content

Commit e62ed6d

Browse files
committed
update readme
1 parent c71c412 commit e62ed6d

File tree

8 files changed

+48
-10
lines changed

8 files changed

+48
-10
lines changed

cli.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
2) Install the required dependencies :
88

9-
pip install numpy onnxruntime imageio
9+
pip install numpy onnxruntime==1.21.0 imageio
1010

1111
# Usage
1212

@@ -28,4 +28,12 @@ See `python3 cli.py -h` for a list of possible arguments. Some examples :
2828

2929
python3 cli.py normals.png curvature.png normals_to_curvature
3030

31-
python3 cli.py normals.png curvature.png normals_to_curvature --normals_to_curvature-blur_radius SMALLEST
31+
python3 cli.py normals.png curvature.png normals_to_curvature --normals_to_curvature-blur_radius SMALLEST
32+
33+
**Low resolution → High resolution** :
34+
35+
python3 cli.py lowres.png highres.png lowres_to_highres
36+
37+
python3 cli.py lowres.png highres.png lowres_to_highres --lowres_to_highres-scale_factor x2
38+
39+
Add `--verbose` to print progress.
File renamed without changes.

img/color_to_normals.jpg

162 KB
Loading

img/location.jpg

112 KB
Loading

img/lowres_to_highres.jpg

139 KB
Loading

img/normals_to_curvature.jpg

136 KB
Loading

img/normals_to_height.jpg

110 KB
Loading

readme.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
![DeepBump](banner.jpg)
1+
<img src="img/banner.jpg" style="border-radius:8px">
2+
3+
<br>
24

35
# DeepBump
46

@@ -8,23 +10,51 @@ DeepBump is a machine-learning driven tool to generate normal & height maps from
810

911
1) [Download DeepBump as a ZIP](https://github.com/HugoTini/DeepBump/releases).
1012

11-
2) In Blender, go to _Edit -> Preferences -> Add-ons -> Install_ and select the downloaded ZIP file. Then enable the add-on.
13+
2) In Blender, go to **_Edit -> Preferences -> Add-ons -> Top right arrow -> Install from disk_** and select the downloaded ZIP file. Then enable the add-on.
1214

13-
3) In the add-on preference, click the '_Install dependencies_' button (this requires an internet connection and might take a while). In case of error, try running Blender as administrator for this step.
15+
3) In the add-on preference, click the **'_Install dependencies_'** button (this requires an internet connection and might take a while). In case of error, try running Blender as administrator for this step.
1416

15-
By installing those dependencies, be aware of [Microsoft conditions](https://github.com/microsoft/onnxruntime/blob/master/docs/Privacy.md). This add-on use available APIs to disable telemetry.
17+
By installing those dependencies, be aware of [Microsoft conditions](https://github.com/microsoft/onnxruntime/blob/master/docs/Privacy.md). This add-on uses available APIs to disable telemetry.
1618

1719
# Usage
1820

1921
Check the [blog post](https://hugotini.github.io/deepbump) first video.
2022

21-
In the Shader Editor, in the right panel under the _DeepBump_ tab:
23+
In the **_Shader Editor_**, in the side bar under the **_DeepBump tab_**:
24+
25+
<img src="img/location.jpg" width=512px style="border-radius:8px">
26+
27+
<br>
28+
29+
# Tools
30+
31+
## Color (albedo) → Normals
32+
33+
Select a color image node in the shader editor, then click _Generate Normal Map_.
34+
35+
<img src="img/color_to_normals.jpg" width=512px style="border-radius:8px">
36+
37+
## Normals → Height (displacement)
38+
39+
Select the generated normal map image node in the shader editor, then click _Generate Height Map_.
40+
41+
<img src="img/normals_to_height.jpg" width=512px style="border-radius:8px">
42+
43+
## Normals → Curvature
44+
45+
Select the generated normal map image node in the shader editor, then click _Generate Curvature Map_.
46+
47+
<img src="img/normals_to_curvature.jpg" width=512px style="border-radius:8px">
48+
49+
## Low res -> High res (upscale)
50+
51+
Select a color image node in the shader editor, then click _Upscale_.
2252

23-
**Color (albedo) → Normals** : Select a color image node and click _Generate Normal Map_.
53+
<img src="img/lowres_to_highres.jpg" width=512px style="border-radius:8px">
2454

25-
**Normals → Height (displacement)** : Select the generated normal map image node and click _Generate Height Map_.
55+
<br>
2656

27-
**Normals → Curvature** : Select the generated normal map image node and click _Generate Curvature Map_.
57+
# Command line
2858

2959
For command-line usage, see [cli.md](cli.md).
3060

0 commit comments

Comments
 (0)