Skip to content

Latest commit

 

History

History
179 lines (168 loc) · 8.64 KB

README.md

File metadata and controls

179 lines (168 loc) · 8.64 KB

What is Labyrinth?

Labyrinth is an easy-access Spigot development library that assists you in areas that may otherwise have been far more time-consuming.

Maven Central Sonatype Nexus (Snapshots)

GitHub license Github all releases Spiget tested server versions

Importing with Maven

<project>
    <properties>
        <labyrinth.version>1.8.0</labyrinth.version>
    </properties>
    <repositories>
        <!-- For snapshots/versions in development -->
        <repository>
            <id>s01-snapshots</id>
            <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
        </repository>
        <!-- For stable release builds. -->
        <repository>
            <id>sonatype</id>
            <url>https://oss.sonatype.org/content/groups/public/</url>
        </repository>
        <!-- No repository needed for Maven Central versions! :D -->
    </repositories>
    <dependencies>
    <!-- Used for accessing common library functions -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-common</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    <!-- Used specifically for loading/retrieving custom skull items. -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-skulls</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    <!-- Used specifically as a full GUI arsenal (Singular/Paginated/Shared/Live/Slideshow/Anvil). -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-gui</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    <!-- Used specifically for region related services. -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-regions</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    <!-- Used specifically for permission related services (Vault replacement). -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-perms</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    <!-- Used specifically for pastebin/hastebin related services. -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-paste</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    <!-- Used specifically for placeholder provision services. -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-placeholders</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    <!-- Plugin internals, submodules marked to shade (Includes main class + plugin.yml, try not to use this) -->
        <dependency>
            <groupId>com.github.the-h-team</groupId>
            <artifactId>labyrinth-plugin</artifactId>
            <version>${labyrinth.version}</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</project>

Importing with Gradle

    allprojects {
        repositories {
            // Normal releases
            mavenCentral()
            maven {
                // For snapshots/development builds
                url "https://s01.oss.sonatype.org/content/repositories/snapshots"
            }
        }
    }

    dependencies {
        compileOnly 'com.github.the-h-team:labyrinth-common:1.8.0'
        compileOnly 'com.github.the-h-team:labyrinth-gui:1.8.0'
        compileOnly 'com.github.the-h-team:labyrinth-skulls:1.8.0'
        compileOnly 'com.github.the-h-team:labyrinth-regions:1.8.0'
        // for build use only! (includes full plugin and resources)
        compileOnly 'com.github.the-h-team:labyrinth-plugin:1.8.0'
    }

What are its key points?

  • Easy Collection management with pagination
  • Tools for simple, automatic class registration
  • Load External Jars
  • Time, Command, String, Math and List Utilities
  • Custom object! Persistent Data Storage using Base64 serialization
  • In-daemon task scheduling.
  • Custom o(1) o(n) complexity collection/map types.
  • Cuboid/Region API
  • Tablist display API
  • Tab completion utility
  • Safe, common library access to amazing plugins like Vault, Enterprise, PlaceholderAPI & Much More!

API Table of Contents:


Labyrinth

A spigot development tool that makes certain tasks much easier.

Original components licensed for use under the terms of the GNU Lesser General Public License, version 2.1.

Ships with MIT-derived components:

  • Java port of RGBApi by F1b3r; original Kotlin sources can be found here.