Mineforgian
scafall
Simple wrappers for Minecraft classes that make it easier to develop cross-platform APIs, as well as extra tools to help with cross-platform plugin and mod development.
- Загрузки
- 4K
- Подписчики
- 4
- Обновлён
- 21 июня 2026 г.
- Лицензия
- MIT
Опубликован 19 апреля 2026 г.
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.
- The API (created by the plugin/mod dev) accepts wrappers as arguments (e.g.
ScafallItemStack) in functions. - The implementations of those functions
unwrap()the wrapper arguments to the native Minecraft object, work with those (e.g.,ItemStack), andwrap()any return value. - 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)
Ченджлог
1.0-alpha.2.0-fabricАльфа26.2 · 21 июня 2026 г.
Core
- refactor: remove ModIdentifier & make Scafall a TaskOwner
1.0-alpha.2.0-paperАльфа26.2 · 21 июня 2026 г.
Core
- refactor: remove ModIdentifier & make Scafall a TaskOwner
Spigot
- build: shade dataformat hocon into spigot and paper jar
Paper
- build: shade dataformat hocon into spigot and paper jar
1.0-alpha.2.0-spigotАльфа26.2 · 21 июня 2026 г.
Core
- refactor: remove ModIdentifier & make Scafall a TaskOwner
Spigot
- build: shade dataformat hocon into spigot and paper jar
Paper
- build: shade dataformat hocon into spigot and paper jar
1.0-alpha.1.0Альфа26.2 · 20 июня 2026 г.
General
- update to Minecraft 26.2
- move adventure utilities into a separate standalone module.
Making it possible to selectively shade them into your project when needed.
Identifiers
- add
Key.parsefunction with default namespace
Core
- Removed Adventure Audiences abstraction
Important! Spigot Deprecation!
Due to PaperMC discontinuing maintenance and support for Adventure on the Spigot platform.
We recommend that users of these libraries update to modern platforms that natively support Adventure
This update removes Adventure support, and the Adventure utils are now in a separate module but no longer shaded into the scafall spigot build.
Important: Because of those changes, I am considering dropping support for Spigot/Bukkit in the near future.
I'm still evaluating if there are any other ways, but I'm unable to maintain a custom adventure-platform implementation.
CustomCrafting and especially viewportl make heavy use of Adventure, so yeah... not looking good for spigot so far.
1.0-alpha.1.0Альфа26.2 · 20 июня 2026 г.
General
- update to Minecraft 26.2
- move adventure utilities into a separate standalone module.
Making it possible to selectively shade them into your project when needed.
Identifiers
- add
Key.parsefunction with default namespace
Core
- Removed Adventure Audiences abstraction
1.0-alpha.1.0Альфа26.2 · 20 июня 2026 г.
General
- update to Minecraft 26.2
- move adventure utilities into a separate standalone module.
Making it possible to selectively shade them into your project when needed.
Identifiers
- add
Key.parsefunction with default namespace
Core
- Removed Adventure Audiences abstraction
1.0-alpha.0.5Альфа26.1.2 · 25 мая 2026 г.
General
- move some packages into a separate standalone modules.
Making it possible to selectively shade them into your project when needed.- identifiers
- wrappers
- scheduler
Core
- refactor: rename ModWrapper to ModIdentifier
- build: no longer shade core deps & shade in platform modules instead
Wrappers
- feat: add ItemStackRef.toTemplate for compatibility with ItemStackTemplates
- feat: add ItemStackTemplate wrapper
- feat: add separate util functions to convert to Minecraft types (without wrapper)
- remove entity wrapper functions and properties
- refactor: rename ItemStackSnapshot create function
Scheduler
- fix: missing logger
- feat: TaskOwner for scafall independent task owner support
1.0-alpha.0.5Альфа26.1.2 · 25 мая 2026 г.
General
- move some packages into a separate standalone modules.
Making it possible to selectively shade them into your project when needed.- identifiers
- wrappers
- scheduler
Core
- refactor: rename ModWrapper to ModIdentifier
- build: no longer shade core deps & shade in platform modules instead
Wrappers
- feat: add ItemStackRef.toTemplate for compatibility with ItemStackTemplates
- feat: add ItemStackTemplate wrapper
- feat: add separate util functions to convert to Minecraft types (without wrapper)
- remove entity wrapper functions and properties
- refactor: rename ItemStackSnapshot create function
Scheduler
- fix: missing logger
- feat: TaskOwner for scafall independent task owner support
Комментарии
Загружаем…