Skip to content

Commit ff96256

Browse files
committed
Add documentation for settings
Signed-off-by: Ryan Luu <ryan.luu@ryanluu.dev>
1 parent 0e9f191 commit ff96256

3 files changed

Lines changed: 22 additions & 9 deletions

File tree

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,26 @@
22
<img alt="Fluoroscopy Ore Outline logo" width="512" src="assets/logo.png">
33
</h1>
44

5-
A Minecraft Bedrock resource pack that outlines ores with their block color for faraway identification and easier mining. Fluoroscopy is designed around the [new Bedrock Textures](https://www.minecraft.net/en-us/article/try-new-bedrock-textures) and supports Vibrant Visuals.
5+
A Minecraft Bedrock Vibrant Visuals resource pack that outlines and glows ores with their block color with optional x-ray. Fluoroscopy is designed around the [new Bedrock Textures](https://www.minecraft.net/en-us/article/try-new-bedrock-textures) to match vanilla as much as possible.
66

7-
| Setting | Overworld | The Nether |
8-
| ----------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
9-
| Outline | ![Overworld with ores outlines](assets/outline_overworld_screenshot.png) | ![The Nether with ores outlines](assets/outline_nether_screenshot.png) |
10-
| Outline and Glow | ![Overworld with glowing ores outlines](assets/glow_overworld_screenshot.png) | ![The Nether with glowing ores outlines](assets/glow_nether_screenshot.png) |
11-
| Outline, Glow, and Xray | ![Overworld with glowing ores outlines and xray](assets/xray_overworld_screenshot.png) | ![The Nether with glowing ores outlines and xray](assets/xray_nether_screenshot.png) |
7+
There are three settings to choose from, each providing a different level of visibility for ores:
8+
9+
> [!WARNING]
10+
> Settings other than **Outline** require [Vibrant Visuals](https://www.minecraft.net/en-us/vibrant-visuals-update) to be enabled.
11+
12+
- **Outline**: Outlines ores with their block color.
13+
- **Outline and Glow (default)**: Outlines ores with their block color and adds a glow effect.
14+
- **Outline, Glow, and X-ray**: Outlines ores with their block color, adds a glow effect, and makes all non-ore blocks invisible.
15+
16+
![Fluoroscopy Settings](assets/settings.png)
17+
18+
Each of the three settings can be seen below in both the Overworld and The Nether:
19+
20+
| Setting | Overworld | The Nether |
21+
| -------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
22+
| Outline | ![Overworld with ores outlines](assets/outline_overworld_screenshot.png) | ![The Nether with ores outlines](assets/outline_nether_screenshot.png) |
23+
| Outline and Glow (default) | ![Overworld with glowing ores outlines](assets/glow_overworld_screenshot.png) | ![The Nether with glowing ores outlines](assets/glow_nether_screenshot.png) |
24+
| Outline, Glow, and X-ray | ![Overworld with glowing ores outlines and x-ray](assets/xray_overworld_screenshot.png) | ![The Nether with glowing ores outlines and xray](assets/xray_nether_screenshot.png) |
1225

1326
## Ores
1427

assets/settings.png

3.6 KB
Loading

resource_packs/fluoroscopy/manifest.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"format_version": 3,
33
"header": {
44
"name": "Fluoroscopy",
5-
"description": "Outline ores with their block color for faraway identification and easier mining.",
5+
"description": "Outline and glow ores with their block color with optional x-ray.",
66
"uuid": "cb7b1b70-78c5-4d68-8006-33758047722a",
77
"pack_scope": "global",
88
"version": "2.0.0",
@@ -24,7 +24,7 @@
2424
},
2525
{
2626
"folder_name": "xray",
27-
"name": "Outline, Glow, and Xray",
27+
"name": "Outline, Glow, and X-ray",
2828
"memory_performance_tier": 1
2929
},
3030
{
@@ -44,7 +44,7 @@
4444
},
4545
{
4646
"type": "label",
47-
"text": "Outline, Glow, and Xray - Outlines ores with their block color, adds a glow effect, and makes all non-ore blocks invisible. §eRequires Vibrant Visuals."
47+
"text": "Outline, Glow, and X-ray - Outlines ores with their block color, adds a glow effect, and makes all non-ore blocks invisible. §eRequires Vibrant Visuals."
4848
},
4949
{
5050
"type": "label",

0 commit comments

Comments
 (0)