# Ruler

**Ruler** is a lightweight, client-side selection and measurement tool for Minecraft 1.21.1 (Fabric). It lets you mark two positions in the world and instantly see a clean holographic 3D visualization of the selected area — along with all relevant measurements in a HUD overlay.

Inspired by WorldEdit CUI, but completely standalone. No server plugin or WorldEdit installation required.

---

## How it works

Press **R** to activate the ruler (rebindable under Controls → Ruler).

- **Left-click** a block to set **Pos1**
- **Right-click** a block to set **Pos2**

That's it. The selection renders immediately.

Press **R** again to deactivate and clear the selection.

---

## 3D Visualization

The selection is rendered as a holographic wireframe box directly in the world:

- **XYZ color-coded edges** — X red, Y green, Z blue
- **Subtle inner grid** for spatial orientation
- **Transparent block highlights** at Pos1 (green) and Pos2 (red)
- Single positions are shown before the second is placed
- Clean, modern look — no chunky vanilla-style boxes

---

## HUD Overlay

A small panel in the top-left corner shows:

| Field | Description |
|-------|-------------|
| Pos1 / Pos2 | Block coordinates |
| Distance | Direct 3D diagonal (air-line) |
| X / Y / Z | Dimensions of the selection |
| Area | Footprint (X × Z) |
| Volume | Total blocks (X × Y × Z) |

---

## Languages

Ruler ships with **37 languages** out of the box:

**Standard:** English, Deutsch, Français, Español, Italiano, Português, Русский, Українська, Polski, Nederlands, Svenska, Dansk, Norsk, Suomi, Čeština, Slovenčina, Magyar, Română, Türkçe, Ελληνικά, 简体中文, 繁體中文, 日本語, 한국어, العربية, עברית, Tiếng Việt, ภาษาไทย

---

## Compatibility

- ✅ **Client-side only** — works on any server, no server mod needed
- ✅ **ModMenu** — appears correctly in the mod list
- ✅ Fabric API required

---

## Requirements

- Minecraft **1.21.1**
- Fabric Loader **≥ 0.17.3**
- [Fabric API](https://modrinth.com/mod/fabric-api)

TheRuler