Skip to content

AcheronInteractive/Insights

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Insights (Acheron Interactive Fork)

Note: Please don't create PRs to this unless you understand how patches work.

Fork features:

  • Multi-version support (1.21.4 -> 1.21.10)
  • Uses Mojang mappings to avoid Paper's plugin remapping
  • Fixed error from the plugin mishandling air in scan messages.
  • Dropped unnecessary shaded libraries
    • Smaller file size

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 - 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.

Compiling Acheron Interactive's fork of Insights

  1. Run git submodule update --init --recursive in the repository's base directory to ensure the gitmodule is populated
  2. Run ./patcher p in the repository's base directory to patch the gitmodule with our patches
  3. Run ./patcher b in the repository's base diectory to build the patched version of Insights
  4. Obtain the compiled jar from insight Insights-Patched/jars/

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:

repositories {
  compileOnly("dev.frankheijden.insights:Insights:VERSION")
}

dependencies {
  maven("https://repo.fvdh.dev/releases")
}

Maven:

<project>
  <repositories>
    <!-- Insights repo -->
    <repository>
      <id>fvdh</id>
      <url>https://repo.fvdh.dev/releases</url>
    </repository>
  </repositories>
  
  <dependencies>
    <!-- Insights dependency -->
    <dependency>
      <groupId>dev.frankheijden.insights</groupId>
      <artifactId>Insights</artifactId>
      <version>VERSION</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>
</project>

Addons

See the Insights Wiki on how to implement your own addon for Insights!

Screenshots

Limit blocks per group

GroupLimit

Custom block limit per chunk

CustomLimit

Scan all blocks in a radius around you!

ScanRadius

Apply limitations to WorldEdit!

WorldEditLimit

Limit globally all tiles per chunk!

TileLimit

Scan all tiles in chunks

TileScan

Scan with custom queries

CustomScan

Automatically scan upon chunk entering

AutoScan

Disable blocks in WorldGuard regions (Regex region match)

RegionDisallow