https://github.com/mightypirates/scannable

One scanner to find them, and with eye candy bind them.
https://github.com/mightypirates/scannable

forge java minecraft minecraft-forge mod

Last synced: about 2 months ago
JSON representation

One scanner to find them, and with eye candy bind them.

• Host: GitHub
• URL: https://github.com/mightypirates/scannable
• Owner: MightyPirates
• License: other
• Created: 2017-05-03T22:48:47.000Z (over 7 years ago)
• Default Branch: 1.20.1
• Last Pushed: 2023-11-16T00:31:11.000Z (about 1 year ago)
• Last Synced: 2024-03-26T09:47:21.915Z (9 months ago)
• Topics: forge, java, minecraft, minecraft-forge, mod
• Language: Java
• Homepage: https://minecraft.curseforge.com/projects/scannable
• Size: 1.37 MB
• Stars: 16
• Watchers: 5
• Forks: 21
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Scannable

Scannable is a Minecraft mod that adds a single scanner item and a couple of scanner modules. Using the scanner will bring up a couple of overlays highlighting nearby points of interest, such as animals, monsters and ores, depending on the installed modules.

## License / Use in Modpacks

This mod is [licensed under the **MIT license**](LICENSE). All **assets are public domain**, unless otherwise stated; all are free to be distributed as long as the license / source credits are kept. This means you can use this mod in any mod pack **as you please**. I'd be happy to hear about you using it, though, just out of curiosity.

## Extending

In general, please refer to [the API](src/main/java/li/cil/scannable/api), everything you need to know should be explained in the Javadoc of the API classes and interfaces. The scan result provider API allows registering custom scanning logic, you can provide custom scanner modules by providing a scan result provider as a capability of an item.

### Gradle

To add a dependency to Scannable for use in your mod, add the following to your `build.gradle`:

```groovy

repositories {

    exclusiveContent {

        forRepository { maven("https://cursemaven.com") }

        filter { includeGroup("curse.maven") }

    }

}

dependencies {

    // Forge via ForgeGradle

    implementation(fg.deobf("curse.maven:scannable-266784:4712704"))

    // Fabric via Loom

    modImplementation("curse.maven:scannable-266784:4712705")

}

```