Skip to content
Gunnar edited this page Nov 23, 2024 · 2 revisions

Welcome to the scafall wiki!

Warning

This wiki is still under construction and info may not be correct nor up-to-date!

Prerequisites / Disclaimer

scafall is...

  • based on Kotlin and may provide worse DX or not work when using plain Java
  • still in alpha! The API is not stable!
  • not getting rid of platform specific implementations! It assists you by providing the most commonly used features across platforms.
  • only targets the most recent platform versions, including minor versions.

Prerequisites

  • Gradle with Kotlin scripts - The following examples and tutorials will assume you use both of them
  • Kotlin - Examples and Tutorials will be in Kotlin only

Getting started:

repositories {
    maven(url = "https://artifacts.wolfyscript.com/artifactory/gradle-dev")
}

Shared Plugin Dependency

Set up your project to use scafall from a separately installed plugin/mod dependency.

// TODO

dependencies {
    
}

Standalone

This will set up your project that shades and relocates scafall into a standalone plugin/mod.

Platforms

Since this will be available across platforms, the shading and relocation must be done in each of your platform modules.

Spigot
Sponge