chunk reveal

# Chunk Reveal

**The world only exists where you walk.**

Chunk Reveal is a survival/exploration mod that hides the entire world except the small piece of it you have already explored. Every block you step onto uncovers exactly one **1×1 column**, from the top of the build limit all the way down to bedrock. Step off the path and you are looking into the void — until you go there.

Nothing is deleted, no terrain is generated or destroyed, and your save file stays untouched. It is a pure rendering effect driven by data stored on the server, so it works in single player and on multiplayer servers alike.

—

## Features

* **One step = one column.** Each new block position you walk onto reveals a single 1×1 column, from build height down to bedrock.
* **Boat mode = 5×5.** Sit in a boat and you uncover a 5×5 area per step, so travelling by water feels different from walking.
* **Permanent progress.** Revealed columns are stored per dimension in the world save (`chunkreveal_columns.dat`) and survive restarts, reconnects and server reboots.
* **Binocular zoom.** Hold **X** to zoom like a pair of binoculars (smooth 2× – 12×). While holding X, use the **mouse wheel** to change the zoom level; the last setting is remembered. On-screen indicator shows the current zoom. The key can be rebound in *Options → Controls*.
* **Projectiles open holes.** Shoot or throw something and the column where it lands is revealed: arrows, snowballs, eggs, splash potions, ender pearls, tridents, and other projectiles that report an impact.
* **Multiplayer ready.** The reveal map is server-authoritative and streamed to clients in per-chunk bit sets, so every player sees the same explored world.
* **Per-player “see everything” mode.** An operator can give a single player full vision (`/chunk <player> reveal`) without changing what anybody else sees — handy for building, filming or testing.

—

## How to play

Chunk Reveal turns every world into a fog-of-war map. Good with:

* **Survival / hardcore** — you have to remember landmarks, because you cannot see them from a distance.
* **Horror and adventure maps** — pure darkness everywhere except the trail behind you.
* **Multiplayer servers** — the map grows as the group explores, and every player sees the same holes in the world.
* **Build showcases** — `/chunk @a reveal` reveals everything instantly when you want to look at the result.

—

## Installation

| Requirement | Version |
|—|—|
| Minecraft | 1.20.1 |
| Forge | 47.x |
| Java | 17 |

* Must be installed on **both** the client and the server (or the single-player instance).
* Compatible with LAN worlds.
* No dependencies, no config file needed.

—

## Commands

Operator level 2 required (`/op <player>` or cheats enabled).

| Command | Description |
|—|—|
| `/reveal radius <walk> <boat>` | Reveal radius while walking / while in a boat. `0 0` = 1×1, `2 2` = 5×5. Default: `0 2`. |
| `/reveal here` | Reveals the column you are standing in. |
| `/reveal reset` | Clears the whole reveal map of the current dimension (world becomes void again). |
| `/chunk <player> reveal` | That single player sees the entire world. `/chunk @a reveal` for everyone. |
| `/chunk <player> hide` | Returns that player to normal walked-path reveal. |

`/chunk … reveal` is stored in the world save, so it is remembered after a restart.

—

## Notes & limitations

* The world is hidden **visually only**. Hidden blocks still exist: you can still collide with them, mobs and items still render, sounds and light behave normally.
* Entities (mobs, animals, dropped items, other players) are not hidden.
* Revealing a large area quickly (for example teleporting far away) can cause a short frame hitch while chunk meshes rebuild.
* Zoom does not change mouse sensitivity.
* The mod hooks vanilla chunk meshing. **Chunk renderer replacements such as Embeddium/Rubidium and most performance mods of that kind are not supported** and may render the world normally or crash.
* Safe to remove at any time — it never modifies world data.

—

## FAQ

**Is my world damaged?**
No. Block data, terrain generation, light and collision are untouched; only the rendered mesh is filtered.

**Does it work in single player?**
Yes, the integrated server stores the reveal map exactly like a dedicated server does.

**Can I turn it off temporarily?**
Yes — `/chunk @a reveal` shows everything again, `/chunk @a hide` puts it back. Or just remove the jar.

**Does joining the server with the mod but a vanilla client work?**
No. Client and server must both have the mod, otherwise the connection is rejected.

**Does it work with modded blocks and dimensions?**
Yes. Any block column in any dimension follows the same rules.