Skip to content

Latest commit

 

History

History
73 lines (55 loc) · 2.52 KB

README.md

File metadata and controls

73 lines (55 loc) · 2.52 KB
Raw

Platform abstraction layer

Platform abstraction layer is a library for abstracting away some server platform specific implementations.

Compared to the the previous abstraction library, this library is more modular and main goal was to use composition rather than inheritance to gain access to the platform implementations. This allows users of this API to use other libraries without worrying about compatibility issues.

Supported Minecraft server-platforms

Building

./gradlew build

Usage

repositories {
    maven { // Platform abstraction layer repository
        url = "https://repo.playeranalytics.net/releases"
    }
}

ext.palVersion = "5.0.0"

dependencies {
    implementation "net.playeranalytics:platform-abstraction-layer-api:$palVersion"
    
    // Pick your platform(s)
    implementation "net.playeranalytics:platform-abstraction-layer-bukkit:$palVersion"
    implementation "net.playeranalytics:platform-abstraction-layer-bungeecord:$palVersion"
    implementation "net.playeranalytics:platform-abstraction-layer-nukkit:$palVersion"
    implementation "net.playeranalytics:platform-abstraction-layer-sponge:$palVersion"
    implementation "net.playeranalytics:platform-abstraction-layer-velocity:$palVersion"
}

Include this library in your project and shade/shadow the library classes into the final artifact.
Relocate net.playeranalytics.plugin to a different location to avoid conflicts.

Access the API:

PlatformAbstractionLayer layer;

// org.bukkit.plugin.java.JavaPlugin
layer = new BukkitPlatformLayer(javaPlugin); 
// Object (has @Plugin annotation), File, org.slf4j.Logger
layer = new SpongePlatformLayer(plugin, dataFolder, logger); 
// cn.nukkit.plugin.PluginBase
layer = new NukkitPlatformLayer(pluginBase);
// net.md_5.bungee.api.plugin.Plugin
layer = new BungeePlatformLayer(plugin);
// Object (has @Plugin annotation), ProxyServer, org.slf4j.Logger, Path
layer = new VelocityPlatformLayer(plugin, proxy, logger, dataFolderPath);

See the javadoc for further details on each feature PlatformAbstractionLayer provides.

Features

  • Console logging
  • Access to plugin meta-data, jar-resources and configuration folder
  • Access to platform task scheduling
  • Managing listeners of specific platform