https://github.com/insightsplugin/insights
Insights - Super configurable (region) Limits + Asynchronous Scans [1.21]
https://github.com/insightsplugin/insights
java minecraft minecraft-plugin paper paper-plugin
Last synced: 29 days ago
JSON representation
Insights - Super configurable (region) Limits + Asynchronous Scans [1.21]
- Host: GitHub
- URL: https://github.com/insightsplugin/insights
- Owner: InsightsPlugin
- License: gpl-3.0
- Created: 2019-05-26T19:37:58.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-12-11T19:52:17.000Z (4 months ago)
- Last Synced: 2025-12-12T23:50:27.061Z (4 months ago)
- Topics: java, minecraft, minecraft-plugin, paper, paper-plugin
- Language: Java
- Homepage: https://modrinth.com/plugin/insights
- Size: 5.35 MB
- Stars: 147
- Watchers: 7
- Forks: 37
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Insights
Insights is a plugin which scans arbitrary regions and applies block limitations on them.
Insights' limits are super configurable, allowing for group limits, individual (permission-based) limits, and tile limits.
Each limit is able to be bypassed through permissions, which you can customize in the limits configuration.
Apart from all placeable materials, Insights also supports the limitation of the following static entities:
* Item Frames
* Glow Item Frames
* Armor Stands
* Paintings
* End Crystals
Insights applies a mapreduce design pattern to perform scans asynchronously,
thus keeping the main thread free from counting materials.
Insights also provides an extensive developer API to create your own custom defined region addons,
or to perform arbitrary scans and process those.
For a full description of this plugin, please refer to SpigotMC: https://www.spigotmc.org/resources/56489/
## Extensions
These plugins are extensions on Insights, they must be placed in your `plugins/` folder.
* [InsightsWorldEditExtension](https://github.com/InsightsPlugin/InsightsWorldEditExtension) - Block materials through WorldEdit modifications.
Supports Insights' limits & disallows any placement of limited blocks.
## Addons
Addons define regions for Insights to limit blocks in.
Instead of a limit per chunk, when a block is placed in such a region, it will first count all blocks in that region, and after enforce limits in that region.
Regions are cached to not bother with scans each time a block has been placed.
* [BentoBoxWorldAddon](https://github.com/InsightsPlugin/BentoBoxAddon/releases) - Limit blocks in your BentoBox world (includes bSkyBlock & AcidIslands)
* [GriefPreventionAddon](https://github.com/InsightsPlugin/GriefPreventionAddon/releases) - Limit blocks in your GriefPrevention claims!
* [USkyBlockAddon](https://github.com/InsightsPlugin/USkyBlockAddon/releases) - Limit blocks in your USB islands!
* [IridiumSkyblockAddon](https://github.com/InsightsPlugin/IridiumSkyblockAddon/releases) - Limit blocks in your Iridium islands!
* [PlotSquaredAddon](https://github.com/InsightsPlugin/PlotSquaredAddon/releases) - Limit blocks in your PlotSquared plots!
* [SuperiorSkyblock2Addon](https://github.com/InsightsPlugin/SuperiorSkyblock2Addon/releases) - Limit blocks in your SS islands!
* [LandsAddon](https://github.com/InsightsPlugin/LandsAddon/releases) - Limit blocks in your lands!
* [TownyAddon](https://github.com/InsightsPlugin/TownyAddon/releases) - Limit blocks in your towns!
* [GriefDefenderAddon](https://github.com/galexrt/InsightsGriefDefenderAddon/releases) by [galexrt](https://github.com/galexrt) - Limit your GriefDefender claims!
## Compiling Insights
There are two ways to compile Insights:
### 1. Installing gradle (recommended)
1. Make sure you have [gradle](https://gradle.org/install/) installed.
2. Run the project with `gradle build` to compile it with dependencies.
### 2. Using the wrapper
**Windows**: `gradlew.bat build`
**Linux/macOS**: `./gradlew build`
## Developer API
### Repository / Dependency
If you wish to use snapshot version of Insights, you can use the following repo:
```
https://repo.fvdh.dev/snapshots
```
#### Gradle:
```kotlin
repositories {
compileOnly("dev.frankheijden.insights:Insights:VERSION")
}
dependencies {
maven("https://repo.fvdh.dev/releases")
}
```
#### Maven:
```xml
fvdh
https://repo.fvdh.dev/releases
dev.frankheijden.insights
Insights
VERSION
provided
```
### Addons
See the [Insights Wiki](https://github.com/InsightsPlugin/Insights/wiki/Addon-API) on how to implement your own addon for Insights!
## Screenshots
### Limit blocks per group
### Custom block limit per chunk
### Scan all blocks in a radius around you!
### Apply limitations to WorldEdit!
### Limit globally all tiles per chunk!
### Scan all tiles in chunks
### Scan with custom queries
### Automatically scan upon chunk entering
### Disable blocks in WorldGuard regions (Regex region match)
