# 🧭⛏️ Immersive Deposit Scanner 🛢️🗺️

**Immersive Deposit Scanner**, also called **IDS**, is a Minecraft **NeoForge** addon built for industrial exploration with **Immersive Engineering**, **Immersive Petroleum**, and **JourneyMap**.

IDS automatically tracks mineral deposits and petroleum reservoirs discovered through valid core samples, then displays those discoveries directly on **JourneyMap** using clear waypoints and optional chunk overlays. 🧭📍

This mod is designed for players who want better industrial planning, cleaner drilling routes, resource mapping, and server-friendly exploration — without using x-ray, hidden scanning, or unfair ore detection. ⚙️⛏️🛢️

---

## ✨ Main Features

- ⛏️ Tracks **Immersive Engineering** mineral deposits
- 🛢️ Tracks **Immersive Petroleum** fluid reservoirs
- 🧭 Adds automatic **JourneyMap waypoints**
- 🗺️ Adds optional **chunk boundary overlays**
- 📍 Shows discovered deposits directly on the map
- 🔷 Keeps mineral and petroleum discoveries separated
- 🧱 Supports multiple tracked deposits in the same chunk
- 💾 Saves discoveries on the server
- 🌐 Supports multiplayer synchronization
- 👤 Supports personal discovery tracking
- 🏭 Supports server-wide discovery sharing
- 🔁 Allows manual resync
- 🧪 Allows scanning a held core sample
- 🧹 Allows removing tracked entries
- 🛠️ Designed for industrial modpacks and survival engineering worlds

---

## 📦 Required Dependencies

IDS requires all of the following mods to be installed:

- 🧭 **JourneyMap**
- ⚙️ **Immersive Engineering**
- 🛢️ **Immersive Petroleum**
- 🔧 **NeoForge**
- 🧱 **Minecraft 1.21.1**
- ☕ **Java 21**

⚠️ **Important:**
IDS will not load if **JourneyMap**, **Immersive Engineering**, or **Immersive Petroleum** are missing.

This mod is a required integration addon, not a standalone tracking mod. 🧩

---

## 🧪 How It Works

When a player obtains or uses a valid core sample, IDS reads the deposit information exposed by **Immersive Engineering** and **Immersive Petroleum**. 🔍

If valid data is found, IDS saves the discovery on the server and syncs it to the client. JourneyMap then displays the discovery as a waypoint or chunk overlay. 🗺️📍

A marker can appear at:

- 📌 the exact sample position, when available;
- 🧱 the center of the related chunk, when exact position data is unavailable.

IDS does **not** scan the world for ores.
IDS does **not** use x-ray logic.
IDS does **not** reveal hidden blocks.
IDS only records information legitimately revealed by valid industrial core samples. ✅

---

## 🧭 JourneyMap Integration

IDS uses JourneyMap to display discoveries visually and clearly. 🗺️✨

JourneyMap entries can include:

- 📍 mineral deposit waypoints
- 🛢️ petroleum reservoir waypoints
- 🧱 chunk boundary overlays
- 🎨 separate marker styles for IE and IP
- 🏷️ readable labels with deposit names
- 📊 optional remaining percentage information
- 🧹 automatic cleanup when entries are removed

Default JourneyMap groups:

- ⛏️ `Immersive Deposit Scanner / Immersive Engineering`
- 🛢️ `Immersive Deposit Scanner / Immersive Petroleum`

This makes it easier to plan excavators, pumpjacks, drills, pipelines, mining outposts, and resource routes. 🏭🚧

---

## ⛏️ Immersive Engineering Support

IDS can track mineral deposits discovered through Immersive Engineering core samples. ⚙️⛏️

Tracked information may include:

- 🧱 dimension
- 🗺️ chunk position
- 📍 sample position
- ⛏️ mineral deposit name
- 🔗 mineral identifier
- 👤 discovering player
- 🕒 discovery time
- 🔁 last update time

This helps players plan mining operations and industrial processing setups more efficiently. 🏭

---

## 🛢️ Immersive Petroleum Support

IDS can also track petroleum reservoir information from Immersive Petroleum data. 🛢️🔥

Tracked information may include:

- 🧱 dimension
- 🗺️ reservoir chunk
- 🛢️ reservoir type
- 💧 fluid or resource type
- 📊 remaining amount
- 📈 capacity or maximum amount
- ⚠️ depleted status
- 👤 discovering player
- 🕒 discovery or update time

This is useful for planning pumpjack locations, oil fields, refining chains, and long-distance fluid logistics. 🚧🛢️🏭

---

## 🗺️ Chunk Overlays

IDS can optionally draw chunk overlays on JourneyMap. 🧱🗺️

These overlays help show the exact area connected to a discovered deposit or reservoir.

Useful for:

- 🏭 drilling layout planning
- ⛏️ excavator placement
- 🛢️ pumpjack placement
- 🚧 industrial base expansion
- 🌐 multiplayer resource coordination
- 🧭 avoiding duplicate exploration

If both a mineral deposit and a petroleum reservoir exist in the same chunk, IDS keeps both entries separate. ✅

---

## 🌐 Multiplayer Support

IDS is server-authoritative. 💾🛡️

That means the server controls the discovery database and sends valid entries to clients.

Depending on configuration, discoveries can be:

- 👤 personal to each player;
- 🏭 shared across the whole server.

This makes IDS useful for both private survival worlds and larger industrial multiplayer servers. 🌐⚙️

---

## 💻 Commands

Main command:

`/ids`

Available or planned subcommands:

- 📋 `/ids list`
- ⛏️ `/ids list ie`
- 🛢️ `/ids list ip`
- 🧱 `/ids list currentchunk`
- 🔁 `/ids resync`
- 🧪 `/ids scanheld`
- 🗑️ `/ids remove currentchunk`
- 🧹 `/ids clear mine`
- 🛠️ `/ids debug heldsample`

Some commands may require operator permissions depending on server configuration. 🔐

---

## ⚙️ Configuration

IDS can be configured for different playstyles and server rules. 🛠️

Possible configuration options include:

- 👤 personal or server-wide discovery sharing
- ⛏️ enable or disable Immersive Engineering tracking
- 🛢️ enable or disable Immersive Petroleum tracking
- 🧭 enable or disable JourneyMap waypoints
- 🧱 enable or disable chunk overlays
- 📊 show or hide remaining percentage
- 🏷️ customize JourneyMap group names
- 🎨 customize overlay colors
- 🔍 enable debug logging

This allows modpack creators and server owners to tune IDS for their progression style. 📦⚙️

---

## 🏭 Recommended For

IDS is recommended for:

- ⚙️ Immersive Engineering worlds
- 🛢️ Immersive Petroleum setups
- 🏭 industrial modpacks
- 🧭 JourneyMap exploration
- ⛏️ mining-focused survival worlds
- 🌐 multiplayer engineering servers
- 🚧 large base planning
- 🧪 core sample management
- 📍 deposit mapping
- 🧱 chunk-based resource planning

---

## 🚫 What IDS Does Not Do

IDS is not an x-ray mod. ❌

IDS does not:

- ❌ scan the world for hidden ores
- ❌ reveal blocks through terrain
- ❌ locate resources without valid sample data
- ❌ modify Immersive Engineering deposits
- ❌ modify Immersive Petroleum reservoirs
- ❌ create fake resource locations
- ❌ replace JourneyMap
- ❌ replace Immersive Engineering or Immersive Petroleum

IDS only records and displays information that is already legitimately discovered. ✅

---

## 🧼 Clean-Room Notice

Immersive Deposit Scanner is an original clean-room implementation. 🧼

This mod does not contain code, textures, logos, assets, or files copied from:

- Mineral Tracker
- Cartography
- JourneyMap
- Immersive Engineering
- Immersive Petroleum

IDS only integrates with required external mods through public behavior, supported APIs, and compatible data exposed during normal gameplay. 🧩

---

## 🙏 Credits & Attribution

Special credit to **LordFokas**, creator of **Mineral Tracker**, for the original public concept of map-based mineral tracking. IDS is not a direct port and does not use Mineral Tracker code or assets. 🧭

Credit to **techbrew** and the **JourneyMap** project for the mapping platform used by IDS. 🗺️

Credit to **BluSunrize**, **Damien Hazard**, and the **Immersive Engineering** team for Immersive Engineering. ⚙️

Credit to **Flaxbeard**, **TwistedGate**, and the **Immersive Petroleum** team for Immersive Petroleum. 🛢️

All referenced mods remain the property of their respective authors and teams. IDS is an unofficial addon and is not affiliated with or endorsed by those projects unless explicitly stated otherwise. 📜

---

## 📌 Short Summary

Track Immersive Engineering mineral deposits and Immersive Petroleum reservoirs, then display them on JourneyMap with waypoints and chunk overlays. 🧭⛏️🛢️

---

## 🧱 Version Target

- 🧱 Minecraft: **1.21.1**
- 🔧 Loader: **NeoForge**
- ☕ Java: **21**
- 🧭 Required: **JourneyMap**
- ⚙️ Required: **Immersive Engineering**
- 🛢️ Required: **Immersive Petroleum**

---

## 🏷️ Tags

`JourneyMap` `Immersive Engineering` `Immersive Petroleum` `Core Sample` `Mineral Tracking` `Oil Reservoir` `NeoForge` `Industrial` `Mapping` `Exploration`