🌍 Overview

A Minecraft metal detector mod written in Python using Minescript and mc-megascan that helps you locate ores in-game. It has a strong docstring within its source code, maintaining readability and accessibility for anyone aiming to use it in their projects.

This was conceived for Minescript v4.0

Please star this repository if you find it useful ⭐

⚠️ Disclaimer

Using this script outside of your own server is considered cheating. You must ask the administrators for authorization before using such scripts online.

I am not responsible of your usage of the mc-MetalDetector, keep in mind that this should not be allowed in multiplayer and will be considered as X-ray.

🛑 Use it at your own risks.

📦 Installation

1. Follow installation instructions for mc-megascan
2. Put the metaldetector.py file into your minescript folder, where your mc-megascan file (megascan.py) is also located
3. You can now run the MetalDetector in-game using the command \metaldetector with Minescript installed

📚 Usage

Run this script in Minecraft by typing \metaldetector in the chat. Notice that this is a backslash "\" not a usual slash "/"

Displays the generic help message

\metaldetector help

Overall basic usage is split in 3 arguments: the command, the mode and the ore

\metaldetector <command> <mode> <ore>

For now, there is only one possible command which is start, so, every use of the MetalDetector should begin as follows
Note that you could also replace start by s

\metaldetector start <mode> <ore>

Then there are 3 different modes that modify the behavior of the MetalDetector:

• check : It will check for a specific ore in your area one time, then will stop. Mostly used to perform a quick single check of your area

• radar : It will keep checking for a specific ore around you until you press a keybind (CTRL + M by default). If you get too far from a detected ore, this ore will not show up

•  map   : Same as the radar mode, but will keep in memory ores that were previously within range, until you mine it, of course. Useful when traveling at high speed for example

So the command will be composed as follows

\metaldetector start check <ore>

\metaldetector start radar <ore>

\metaldetector start map <ore>

Each mode has a "shortcut" version of itself; For example, the check mode could also be written as c, 1, or single

\metaldetector s c <ore>

Shortcut versions of modes:

• check : c , 1 , single

• radar : r , 2

•  map   : m , 3 , memory

And last but not least, you will have to specify an ore to search for, or an array of ores

\metaldetector s c diamond

As with the other arguments, there are shortcut versions and/or aliases for each ore
These are, generally speaking, the first three characters of the ore (e.g: diamond could be written dia)

Shortcut versions of ores:

• coal : coa

• copper : cop

• diamond : dia

• emerald : eme

• gold : gol

• iron : iro

• lapis : lap , lazuli

• netherite : net , ancient , anc , debris

• quartz : qua

• redstone : red

• overworld : None

• nether : None

As you can see, you can also specify a dimension, so it will only scan for ores that are generated in this specific dimension

\metaldetector s c overworld

By default, leaving an argument empty after the start command will lead to the MetalDetector searching for netherite a single time ;)

All these default values and settings can be changed anytime at the line 255 of the metaldetector.py

To search for anything else than ores, please use mc-megascan

🖼️ Gallery

Screenshot of a player using the MetalDetector on `radar` to find coal

🗒️ Credits

M4elstr0m for conceiving this script (mc-MetalDetector) you are currently consulting on Github

maxuser for creating the wonderful Minescript mod

All the people who starred one of my repositories