https://github.com/seggan/sf4k

A library for using Kotlin to write Slimefun addons
https://github.com/seggan/sf4k

Last synced: about 2 months ago
JSON representation

A library for using Kotlin to write Slimefun addons

• Host: GitHub
• URL: https://github.com/seggan/sf4k
• Owner: Seggan
• License: apache-2.0
• Created: 2024-01-19T22:04:20.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-10-30T20:56:54.000Z (2 months ago)
• Last Synced: 2024-10-30T21:28:45.666Z (2 months ago)
• Language: Kotlin
• Size: 146 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sf4k

![Maven Central Version](https://img.shields.io/maven-central/v/io.github.seggan/sf4k)

[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://seggan.github.io/sf4k/)

sf4k is a library for Kotlin that provides a useful base and utilities for writing 

[Slimefun](https://github.com/Slimefun/Slimefun4) addons. 

## Installation

### Gradle

```kotlin

repositories {

    mavenCentral()

}

dependencies {

    implementation("io.github.seggan:sf4k:[VERSION]")

}

```

### Maven

```xml

    io.github.seggan

    sf4k

    [VERSION]

```

## How to use

sf4k provides `AbstractAddon` as a base class for you to extend from, as Kotlin does not allow

you to extend both `JavaPlugin` and `SlimefunAddon` at the same time.

sf4k also provides a few convenience functions, such as destructuring and operator overloads for

`Location`, and `BlockStorage` serialization interface. See the [docs](https://seggan.github.io/sf4k/)

for more information.