Skip to content
This repository was archived by the owner on May 6, 2026. It is now read-only.

Commit 38e883b

Browse files
committed
Update README.md & Adjust Plugin Labels
Added README images Adjusted Button and Label Texts for the Plugin
1 parent 7d3d3f3 commit 38e883b

4 files changed

Lines changed: 34 additions & 25 deletions

File tree

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Environment LOD Tools
22

3+
<p align="center">
4+
<img width="960" height="410" src="https://raw.githubusercontent.com/gojushin/EnvironmentLodTools/main/docs/resources/enviro_lod_tools_example.jpg" alt="LOD Example logo">
5+
</p>
6+
37
This is a collection of plugins for [Blender](https://www.blender.org/) (v. 4.0.0 and above).
48
The plugins are designed to help with the creation of environment levels of detail (LODs) for terrestrial photogrammetry models.
59
(Models of Landscapes, Cities, and other "flat" structures).
@@ -8,26 +12,20 @@ The plugin is split into several single plugins, that can be used independently
812
There is also a combined plugin that can load a model from the file system and generate LODs for it, without actively rendering it to the viewport.
913
**This is essential for source files that are too massive to display in the viewport.**
1014

11-
A version that runs entirely headless is also planned.
12-
1315
### Features
1416

1517
- **Cleanup**: Cleans/Preprocesses the mesh for use in the LOD pipeline.
16-
- **Mesh Slicer**: Cuts a mesh into a user-defined amount of square slices.
17-
- **LOD Pipeline**: Generates the levels of detail (LODs) for all the selections using the provided settings.
18+
- **Mesh Slicer**: Cuts a mesh into a user-defined amount of square slices. (This reimplements Blenders Bisect logic in a way that does not require to duplicate the mesh in order to keep both halfs)
19+
- **LOD Pipeline**: Generates the levels of detail (LODs) for all the selections using the provided settings. The LOD generation retains the borders of the highest LOD for flawless LOD transitions of individual modules.
1820
- **XAtlas Unwrapper**: Unwraps the model using the [xatlas-python](https://github.com/mworchel/xatlas-python) bindings.
1921
- **Baker**: Transfers the base color of a defined mesh onto one or multiple selected meshes.
2022

2123

22-
### Installation
23-
24-
## Plugin
25-
To install the plugins, follow these steps:
24+
# Installation
2625

27-
1. Download the [latest release](https://github.com/gojushin/EnvironmentLodTool/releases/latest) from GitHub.
28-
2. In Blender, go to `Edit` -> `Preferences` -> `Add-ons` and click on the `Install` button.
29-
3. Select the .zip file from the download folder.
30-
4. Enable the plugins by checking the plugins checkbox. *Note: This invokes pip to install xatlas to blenders environment and can therefore cause Blender to hang for a second.*
26+
<p align="start">
27+
<img width="509" height="475" src="https://raw.githubusercontent.com/gojushin/EnvironmentLodTools/main/docs/resources/enviro_lod_tools_gui_example.jpg" alt="GUI Example">
28+
</p>
3129

3230
## GUI
3331
EnvironmentLodTools can also be used with a "standalone" PySide6 based GUI.
@@ -39,9 +37,20 @@ To use the GUI do the following:
3937
3. Run `pip install -r requirnments.txt` in the directory of the plugin.
4038
4. Start the GUI by executing `enviro_tools_gui.py`
4139

40+
## Plugin
41+
To install the plugins, follow these steps:
42+
43+
1. Download the [latest release](https://github.com/gojushin/EnvironmentLodTool/releases/latest) from GitHub.
44+
2. In Blender, go to `Edit` -> `Preferences` -> `Add-ons` and click on the `Install` button.
45+
3. Select the .zip file from the download folder.
46+
4. Enable the plugins by checking the plugins checkbox. *Note: This invokes pip to install xatlas to blenders environment and can therefore cause Blender to hang for a second.*
47+
4248
### Usage
4349

44-
Once installed, the plugins can be accessed through the `Tool` panel.
50+
Once installed, the plugins can be accessed through the `Tool` and `Tools` panel.
51+
52+
To use the GUI, download the source code and execute the `enviro_tools_gui.py` file.
53+
_Note: Since Blender is non-thread safe by nature, the GUI will currently freeze. You can track the progress in the CLI._
4554

4655
### Contributing
4756

1.24 MB
Loading
300 KB
Loading
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
CLEANUP_IDNAME = "mesh.clean_mesh_operator"
2-
CLEANUP_LABEL = "Cleans the selected mesh."
2+
CLEANUP_LABEL = "Clean selection"
33
CLEANUP_PANEL_IDNAME = "MESH_PT_clean"
4-
CLEANUP_PANEL_LABEL = "Clean Mesh Panel"
4+
CLEANUP_PANEL_LABEL = "Mesh Pre-Processing"
55

66
SLICE_IDNAME = "mesh.mesh_slicer_operator"
7-
SLICE_LABEL = "Slices the selected mesh."
7+
SLICE_LABEL = "Slice selection"
88
SLICE_PANEL_IDNAME = "MESH_PT_slice"
9-
SLICE_PANEL_LABEL = "Slices the selected mesh."
9+
SLICE_PANEL_LABEL = "Mesh Slicing"
1010

1111
LOD_IDNAME = "mesh.lod_gen_operator"
12-
LOD_LABEL = "Creates LODs of the selected mesh, sorted into groups, using the Bake Settings"
12+
LOD_LABEL = "Create LODs"
1313
LOD_PANEL_IDNAME = "MESH_PT_lod"
14-
LOD_PANEL_LABEL = "Creates LODs of the selected mesh, sorted into groups, using the Bake Settings"
14+
LOD_PANEL_LABEL = "LOD Creation"
1515

1616
UNWRAP_IDNAME = "mesh.xatlas_unwrap_operator"
17-
UNWRAP_LABEL = "Unwraps the selected Mesh using xAtlas."
17+
UNWRAP_LABEL = "Unwrap (xAtlas)"
1818
UNWRAP_PANEL_IDNAME = "MESH_PT_xatlas_unwrap"
19-
UNWRAP_PANEL_LABEL = "Unwraps the selected Mesh using xAtlas."
19+
UNWRAP_PANEL_LABEL = "xAtlas Unwrapping"
2020

2121
BAKE_IDNAME = "mesh.multi_bake_operator"
22-
BAKE_LABEL = "Bakes the selected meshes using a single highpoly reference."
22+
BAKE_LABEL = "Bake selection"
2323
BAKE_PANEL_IDNAME = "MESH_PT_bake"
24-
BAKE_PANEL_LABEL = "Bakes the selected meshes using a single highpoly reference."
24+
BAKE_PANEL_LABEL = "Texture Transfer"
2525
BAKE_SETTINGS_IDNAME = "prop.bake_settings"
2626

2727
COMB_IDNAME = "mesh.terrestrial_lod_gen_operator"
28-
COMB_LABEL = "Generates LOD steps for the defined mesh."
28+
COMB_LABEL = "Run Pipeline"
2929
COMB_PANEL_IDNAME = "MESH_PT_terrestrial_lod"
30-
COMB_PANEL_LABEL = "Generates LOD steps for the defined mesh."
30+
COMB_PANEL_LABEL = "Combined Pipeline"

0 commit comments

Comments
 (0)