scafall

The main goal of scafall is to provide a lightweight wrapping solution for creating cross-platform APIs.
A secondary goal is to provide utils for the most used parts of each platform, such as Tasks & Scheduling or Kotlin-specific convenience utils for libraries like Adventure.

Note: Scafall is a development library not meant to be used by players or provide gameplay features. Other plugins/mods may require it as a dependency.

Proxy Interfaces

Scafall avoids wrapping every Platform/Minecraft feature by providing simple wrapper interfaces, that are only used as a kind of proxy.

1. The API (created by the plugin/mod dev) accepts wrappers as arguments (e.g. ScafallItemStack) in functions.
2. The implementations of those functions unwrap() the wrapper arguments to the native Minecraft object, work with those (e.g., ItemStack), and wrap() any return value.
3. Other Mods/Plugins wrap() their platform-specific objects (e.g., org.bukkit.inventory.ItemStack) and pass those into the API.

These interfaces are lightweight and provide access to very few properties of the wrapped object. The idea is to purely use them as a transfer between Mods/Plugins, API, and Implementation, allowing for easier sharing of common code between platforms.

Scafall uses Minecraft as the ground truth, so proxies always wrap the native Minecraft types.
When wrapping other platform types, those are first converted into the native MC types.
(Spigot/Paper objects are usually wrappers themselves, in which case it just uses that wrapped value)

Limitations & Memory Concerns

The same limitation applies to wrappers as they do to native types. That means one should never attempt to store a wrapper in a list or map, as that would lead to memory leaks. They are intended to be used only as parameters or return values to/from API calls.

Work in Progress

This is still a work-in-progress project, so don't expect anything to work seamlessly. There is no guarantee of API compatibility yet, but it will be provided eventually. The current API is still unstable and likely to change at anytime without notice!

Additional Modules/Libraries

The goal of this project is to really just provide the basic scaffolding and assist in the development process.
Additional Modules/Libraries may use scafall to provide more niche APIs and Utils.

• viewportl - Minecraft UI Framework based on Compose Runtime, for powerful, reactive and efficient UIs.
  (Uses scafall to make it possible to create cross-platform UIs)