Metadata-Version: 2.4
Name: orefinder-estimate
Version: 1.0.0
Summary: Fast offline Minecraft ore estimator: best mining Y and the areas where ores are most likely to concentrate for Java and Bedrock. Pairs with orefinder.io for seed-exact coordinates.
Author-email: Ore Finder <hello@orefinder.io>
License: MIT
Project-URL: Homepage, https://orefinder.io
Project-URL: Repository, https://github.com/nazzal5448/ore-finder-pkgs
Project-URL: Bug Tracker, https://github.com/nazzal5448/ore-finder-pkgs/issues
Keywords: minecraft,ore,diamond,mining,seed,java,bedrock,orefinder,nether
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment
Classifier: Intended Audience :: Developers
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# orefinder-estimate (PyPI)

A tiny, fast, pure-Python (no dependencies) Minecraft ore **estimator**.
Feed it a seed label, version, and player position; get back likely ore
coordinates and the best mining Y for Java or Bedrock.

> Fast, offline estimates of the best mining Y and where an ore is likely to
> concentrate. For pinpoint, seed-exact coordinates (Java & Bedrock), pair it with
> https://orefinder.io.

## Install

```bash
pip install orefinder-estimate
```

## Usage (library)

```python
from orefinder_estimate import estimate

result = estimate({
    "seed": "42",
    "version": "java_1_21",
    "ore": "diamond",
    "x": 0, "y": 64, "z": 0,
    "biome": "plains",
    "searchRadius": 220,
})

print(result["metadata"]["miningPeakY"])  # suggested Y
best = result["bestCluster"][0]
print(best["x"], best["y"], best["z"], best["probabilityPct"])
```

## Usage (CLI)

```bash
orefinder-estimate --seed 42 --version java_1_21 --ore diamond -x 0 -y 64 -z 0
orefinder-estimate --ore ancient_debris --version java_1_21 --biome crimson_forest --json
orefinder-estimate --ores          # list supported ores
```

## Supported ores

diamond, iron, gold, coal, copper, emerald, redstone, lapis, ancient_debris
(with netherite aliases), nether_gold, nether_quartz, gilded_blackstone,
blackstone.

## Notes

- Pure statistics over published Y-distribution ranges; deterministic for a
  given input, and identical to the sibling packages in other languages.
- No world-gen simulation, no structures, and **no network calls**.
- Seed-accurate placement and structure finding live at
  [orefinder.io](https://orefinder.io).

MIT licensed. (c) [Ore Finder](https://orefinder.io).
