Giter Club home page Giter Club logo

insights's Introduction

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/

Java CI with Gradle releaseImg licenseImg featureRequestsImg bugReportsImg spigotRatingImg spigotDownloadsImg

Discord

bStatsImg

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 Insights

There are two ways to compile Insights:

1. Installing gradle (recommended)

  1. Make sure you have gradle 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:

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

insights's People

Contributors

frankheijden avatar dependabot-preview[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.