Server Modding API for Minecraft.
Sandstone is very inspired by SpongePowered (Some API characteristics is very similar (likely identical) to SpongePowered), and Bukkit API, but the Sandstone purpose is a bit different, Sandstone API aims to support all Minecraft Editions Platforms.
- Mc Version:
1.12.2 - SandstoneAPI Version:
1.0.0-SNAPSHOT(WIP)
Sandstone is a Server Modding API for Minecraft that aims to provide a common API to develop mods that works in multiple Minecraft Editions, Sandstone is designed to support Minecraft PE and Minecraft PC Edition. Sandstone is not a server, it's only a API, and the API is implemented by a Platform-Dependent plugin (like SandstoneBukkit, SandstoneSponge and SandstoneNukkit), Sandstone is written in Kotlin, and we plan to provide a LUA Plugin API to support non-JVM platforms like PocketMine-MP.
- Java
- Kotlin (partial)
- Scala (
objectplugins only)
- Bukkit
- Sponge
- Nukkit
It depends on implementation, but commonly we use Adapter pattern and weak cache some instances.
Does not compare Sandstone objects by identity (== in Java and === in Kotlin), use the equals method in Java and == in Kotlin to compare objects
Adapter delegates hashCode and equals methods to Adaptee instance.
Please report any inconsistency between platforms, Sandstone MUST be consistent between Platforms, if operation c() returns 9 in Platform A then the same operation MUST return 9 in Platform B, Platform C...
Inconsistencies MUST be reported and fixed in the implementation and not in the API or Common project.
Sandstone provides debug parameters to save generated classes:
| Project | Parameter | Description |
|---|---|---|
| EventSys | kores.generation.dir.eventsys=/save/dir |
Defines class save directory |
| EventSys | kores.generation.save.eventsys=true |
Enables global generated class save |
| EventSys | kores.generation.save.eventsys.factorygen=true |
Enables save of factory generated class |
| EventSys | kores.generation.save.eventsys.eventgen=true |
Enables save of event generated class |
| EventSys | kores.generation.save.eventsys.listenergen=true |
Enables save of listener generated class |
| EventSys | kores.generation.save.eventsys.directgen=true |
Enables save of listener generated class |
| KoresProxy | koresproxy.saveproxies=true |
Enables save of proxy generated classes |
Sandstone provides debug vm parameters to save all Sandstone generated classes: -Dsandstone.debug=true.
If you want to save only Event implementation generated classes: -Deventsys.debug=true
CodeProxy provides -Dcodeproxy.saveproxies=true to save Proxy classes
Obs: these parameters is for debug purposes only, saved classes help us to find bugs in the Code Generator, if you are not a advanced user trying to find the cause of a bug, does not use these parameters!!!