Skip to content

Commit 8b69087

Browse files
committed
Update README.md
1 parent 839e0e5 commit 8b69087

1 file changed

Lines changed: 28 additions & 42 deletions

File tree

README.md

Lines changed: 28 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,83 @@
11
# LightmapProbeGrid
2+
> ### Create a grid of Lightmap Probes and cut unwanted ones!
3+
24
<p align="center" width="100%">
35
<img width="600px" src="https://github.com/user-attachments/assets/8d94f78a-b288-44a5-9050-fc3e8c266bb0">
46
</p>
57

68

7-
Create a grid of Lightmap Probes and cut unwanted ones!
8-
9-
LightmapProbeGrid is an extension for [Godot Engine](https://godotengine.org/) that helps on the demanding task of placing Lightmap Probes where LightmapGI fails to do it.
10-
11-
**Disclaimer:** If you are getting the error `scene/3d/lightmap_gi.cpp:529 - Inconsistency found in triangulation...` is because [Godot Issue 82642](https://github.com/godotengine/godot/issues/82642). It was fixed on Godot 4.3.
12-
13-
### Video Tutorial
14-
https://www.youtube.com/watch?v=HzZSQ0BPpuk
9+
## What is it?
10+
LightmapProbeGrid is a plugin for [Godot Engine](https://godotengine.org/) that helps on the demanding task of placing Lightmap Probes where LightmapGI fails to do it.
1511

16-
# Index
17-
* [What's new](#whats-new)
18-
* [How to install](#how-to-install)
19-
* [Making a grid of Light Probes](#making-a-grid-of-light-probes)
20-
* [Cut Obstructed Probes](#cut-obstructed-probes)
21-
* [Cut probes inside objects](#cut-probes-inside-objects)
22-
* [Cut probes far from objects](#cut-probes-far-from-objects)
23-
* [Limitations](#limitations)
24-
* [Compatibility](#compatibility)
25-
* [Ending notes](#ending-notes)
26-
* [Changelog](#changelog)
12+
**Video Tutorial:** https://www.youtube.com/watch?v=HzZSQ0BPpuk
2713

28-
# What's New
29-
Thanks to [dwarfses](https://twitter.com/dwarfses/status/1731691097263362513), LightmapProbeGrid v2.0 now uses GPU raycast instead of the regular Physics raycast. It may be slower but means that colliders are not needed anymore! If the camera can see, it should work!
3014

31-
NOTE: The Cull Mask from v1.0 is not compatible with v2.0.
32-
33-
v2.1 includes support for Godot 4.3
34-
35-
# How to install
15+
## How to install
3616
1) Download the file `LightmapProbeGrid_v2.1.zip` from the [Download Page](https://github.com/SpockBauru/LightmapProbeGrid/releases)
3717
2) Extract the `addons` folder on the root of your project (`res://`). Other files/folders are optional.
3818
3) Go to Godot's "Project" menu -> "Project Settings" -> "Plugins" tab -> enable "LightmapProbeGrid".
3919
4) Restart Godot.
4020

4121
You can also open the `DemoScene` to see how it works.
4222

43-
# Making a grid of Light Probes
23+
24+
## Making a grid of Light Probes
4425
- Place the LightmapProbeGrid Node in the scene. It's located at "Add Node" -> Node3D -> LightmapProbeGrid.
4526
- Use the handles (red dots) to resize the grid.
4627
- In the LightmapProbeGrid Inspector you can set the number of Light Probes on each axis with the minimum of 2. Press "Generate Probes" to apply the settings and place your grid of Light Probes in the Scene.
4728

4829
Now you can cut unwanted probes with the methods bellow.
4930

50-
## Cut Obstructed Probes
51-
This method is designed to cut probes that are placed beyond visual limits such as the ground or the walls of a cave.
52-
53-
On LightmapProbeGrid Inscpector click on "Cut Obstructed Probes". It will test each Light Probe from the center of the grid to the probe and see if the line intercepts an object. The probe will be cut if there's something blocking the line.
5431

32+
### Cut Obstructed Probes
5533
<p align="center" width="100%">
5634
<img width="600px" src="https://github.com/user-attachments/assets/c03287bc-630e-48ce-ab58-8aacbe6f44ac">
5735
</p>
5836

37+
This method is designed to cut probes that are placed beyond visual limits such as the ground or the walls of a cave.
5938

60-
## Cut probes inside objects
61-
This method is designed to delete probes that are inside objects. It will test all 6 axis of each Light Probe: Up, Down, Left, Right, Forward and Backward by the distance indicated in `Max Object Size`.
39+
On LightmapProbeGrid Inscpector click on "Cut Obstructed Probes". It will test each Light Probe from the center of the grid to the probe and see if the line intercepts an object. The probe will be cut if there's something blocking the line.
6240

63-
If at least 4 of these lines hit something the probe will be cut. It considers only 4 hits to cut probes on long objects like pillars and trees.
6441

42+
### Cut probes inside objects
6543
<p align="center" width="100%">
6644
<img width="450px" src="https://github.com/user-attachments/assets/4d11293d-a129-4f4f-af84-75552cdc113a">
6745
</p>
6846

47+
This method is designed to delete probes that are inside objects. It will test all 6 axis of each Light Probe: Up, Down, Left, Right, Forward and Backward by the distance indicated in `Max Object Size`.
6948

70-
## Cut probes far from objects
71-
This method is designed to delete probes that are far away from any object. Normally these probes don't contain any relevant light information but use with care in places that have a high usage of spotlights.
49+
If at least 4 of these lines hit something the probe will be cut. It considers only 4 hits to cut probes on long objects like pillars and trees.
7250

73-
When you click the button the area around the Light Probe is tested on various directions by the distance indicated in `Max Distance`. The probe will be cut if none of the rays intercept an object.
7451

52+
### Cut probes far from objects
7553
<p align="center" width="100%">
7654
<img width="600px" src="https://github.com/user-attachments/assets/c2195e0c-efcc-4965-80fc-0b393231e2e5">
7755
</p>
7856

57+
This method is designed to delete probes that are far away from any object. Normally these probes don't contain any relevant light information but use with care in places that have a high usage of spotlights.
7958

80-
## Using masks
59+
When you click the button the area around the Light Probe is tested on various directions by the distance indicated in `Max Distance`. The probe will be cut if none of the rays intercept an object.
60+
61+
62+
### Using masks
8163
You can select which 3D render layers LightmapProbeGrid will interact on the section Visual Cull Mask. Only selected layers will be used on detection for the Cut methods above.
8264

8365
Use masks to filter out objects to not interact with the rays, like characters or moving objects.
8466

85-
# Limitations
67+
68+
## Limitations
8669
LightmapProbeGrid is not designed to work with a huge number of Light Probes at once covering a vast area. It is designed to be placed multiple times in a scene with relatively small grids (less than 1,000 probes).
8770

88-
# Compatibility
71+
72+
## Compatibility
8973
LightmapProbeGrid is compatible with Godot 4.2 and there are plans to continue supporting onward.
9074

91-
# Ending notes
75+
76+
## Ending notes
9277
This tool was entirely made on my free time. If you want to support me, please make an awesome asset and publish for free to the community!
9378

94-
# Changelog
79+
80+
## Changelog
9581
v2.1:
9682
- Support for Godot 4.3
9783

0 commit comments

Comments
 (0)