Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 1.5 KB

README.md

File metadata and controls

56 lines (35 loc) · 1.5 KB
Raw

slf4md

Build status Mindustry 7.0

Description

A set of plugins providing various SLF4J implementations for Mindustry.

Installation

The plugins require:

  • Java 17 or above.

  • Mindustry v146 or above.

Usage

For server owners

If one of your plugins requires slf4md, you don't have to do anything special. Simply choose the implementation that suits your needs and install it on your server (in the config/mods directory):

  • slf4md-simple: A logger that redirects to arc logger (arc.util.Log). No fancy stuff or invasive changes.

For plugin developers

You only need to "compileOnly" slf4j-api in your build.gradle:

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("org.slf4j:slf4j-api:2.0.13")
}

and add slf4md in the dependencies of your plugin.json:

{
  "dependencies": ["slf4md"]
}

Building

  • ./gradlew :slf4md-{module}:shadowJar to compile the plugin into a usable jar (will be located at builds/libs/(plugin-name).jar).

  • ./gradlew :slf4md-{module}:runMindustryServer to run the plugin in a local Mindustry server.

  • ./gradlew :slf4md-{module}:runMindustryDesktop to start a local Mindustry client that will let you test the plugin.