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

Commit 5cc1665

Browse files
authored
Updated README.md
Updated the readme to include instructions for the GUI
1 parent 8b08253 commit 5cc1665

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,23 @@ A version that runs entirely headless is also planned.
2121

2222
### Installation
2323

24+
## Plugin
2425
To install the plugins, follow these steps:
2526

2627
1. Download the [latest release](https://github.com/gojushin/EnvironmentLodTool/releases/latest) from GitHub.
27-
2. Downloaded zip file.
28-
3. In Blender, go to `Edit` -> `Preferences` -> `Add-ons` and click on the `Install` button.
29-
4. Select the .zip file from the download folder.
30-
5. Enable the plugins by checking the plugins checkbox. *Note: This invokes pip to install xatlas to your local environment and can therefore cause Blender to hang for a second.*
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.*
31+
32+
## GUI
33+
EnvironmentLodTools can also be used with a "standalone" PySide6 based GUI.
34+
It exposes the exact same parameters, but uses the users local Python install, with Blender as a module, instead of Blenders Embedded Python.
35+
36+
To use the GUI do the following:
37+
1. Download the entire `source code` from the [latest release](https://github.com/gojushin/EnvironmentLodTool/releases/latest).
38+
2. Open the command prompt.
39+
3. Run `pip install -r requirnments.txt` in the directory of the plugin.
40+
4. Start the GUI by executing `enviro_tools_gui.py`
3141

3242
### Usage
3343

0 commit comments

Comments
 (0)