====== CaveFinder ======

<WRAP 516px>
^  CaveFinder  ^^
|{{ cavefinder.webp?500x280 |Using CaveFinder and X-Ray at the same time.}}||
^Type|[[:Hack]]|
^Category|[[:Render]]|
^In-game description|"Helps you to find caves by\\ highlighting them in the\\ selected color."|
^[[:keybinds#default_keybinds|Default keybind]]|none|
^Source code|[[w7src>net/wurstclient/hacks/CaveFinderHack.java]]|
</WRAP>

CaveFinder is a Minecraft hack that highlights all [[mc>caves]] in the selected color.

CaveFinder works by detecting the [[mc>Cave Air]] block.

===== Settings =====

==== Area ====
^  Area  ^^
^Type|Enum|
^In-game description|"The area around the player to search in.\\ Higher values require a faster computer."|
^Default value|11x11 chunks|
^Possible values|3x3 chunks, 5x5 chunks, 7x7 chunks, 9x9 chunks, 11x11 chunks, 13x13 chunks, 15x15 chunks, 17x17 chunks, 19x19 chunks, 21x21 chunks, 23x23 chunks, 25x25 chunks, 27x27 chunks, 29x29 chunks, 31x31 chunks, 33x33 chunks|

The "Area" setting determines the area around the player in which CaveFinder will search for caves. The area is measured in chunks, not blocks. The default value of 11x11 chunks is equivalent to a 176x176 block area. Setting this to a higher value will cause CaveFinder to search for caves in a larger area, but it will also cause a significant decrease in performance and increase in CPU usage.

==== Limit ====
^  Limit  ^^
^Type|Slider|
^In-game description|"The maximum number of blocks to display.\\ Higher values require a faster computer."|
^Default value|10<sup>5</sup> (or 100,000)|
^Minimum|10<sup>3</sup> (or 1,000)|
^Maximum|10<sup>6</sup> (or 1,000,000)|
^Increment|[[wp>order of magnitude|1 order of magnitude]]|

The "Limit" setting determines the maximum number of blocks to display. The default value of 10<sup>5</sup> (or 100,000) means that CaveFinder will only highlight up to 100,000 blocks at a time, even if there are more caves nearby. Setting this to a higher value will cause CaveFinder to highlight more blocks at once, but it can also negatively affect performance.

Values are displayed as regular numbers, but saved as orders of magnitude (e.g. the default 100,000 blocks value is saved as ''5''). This becomes visible when shift-clicking on the "Limit" slider to manually enter a value: Instead of entering the desired number of blocks directly, the user must enter the desired order of magnitude.

==== Color ====
^  Color  ^^
^Type|[[:ColorSetting|Color]]|
^In-game description|"Caves will be highlighted in this color."|
^Default value|#FF0000 (red)|

The "Color" setting determines the color that CaveFinder will use to highlight caves. The default value of #FF0000 highlights caves in red.

==== Opacity ====
^  Opacity  ^^
^Type|Slider|
^In-game description|"How opaque the highlights should be.\\ 0 = breathing animation"|
^Default value|0% (breathing)|
^Minimum|0% (breathing)|
^Maximum|100%|
^Increment|1%|

The "Opacity" setting determines how opaque the highlights should be. The default value of 0% (breathing animation) means that the highlights will oscillate between 0% and 50% opacity at a frequency of 0.5 Hz.

===== Changes =====

^Version^Changes^
|[[update:Wurst 1.13]]|Added CaveFinder|
|[[update:Wurst 3.0pre1]]|Broke CaveFinder.|
|[[update:Wurst 3.0pre2]]|Fixed CaveFinder.|
|[[update:Wurst 6.2.1]]|Fixed caves not rendering properly when using [[Freecam]] or CaveFinder. (MC 1.11 & 1.10)|
|[[update:Wurst 7.0pre1]]|Temporarily removed CaveFinder.|
|[[update:Wurst 7.0pre26]]|Re-added CaveFinder.|
|:::|CaveFinder now works by highlighting caves in red.|
|[[update:Wurst 7.9]]|Fixed CaveFinder not resetting properly when moving to different [[mc>dimension]].|
|:::|Fixed CaveFinder not working properly on low render distances.|
|[[update:Wurst 7.15.2]]|Fixed CaveFinder crashing the game in Minecraft 21w20a and later versions.|
|[[update:Wurst 7.17]]|Added a "[[#Color]]" setting to CaveFinder. Determines which color CaveFinder uses to highlight caves.|
|:::|Added an "[[#Opacity]]" setting to CaveFinder. Allows you to disable the default breathing animation and set a fixed level of opacity instead.|
|[[update:Wurst 7.25]]|The CaveFinder Opacity slider now says "breathing" instead of "Breathing" when set to zero.|
|[[update:Wurst 7.31]]|Slightly improved performance of [[Search]], CaveFinder and [[BaseFinder]].|

{{tag>client-side has_colorsetting mining}}