ServiceLoader mechanism, so there is no configuration required on the server side beyond dropping the file in the right folder.
Adding Dimensions to Your Project
To start building an addon, downloadDimensions.jar from the SpigotMC resource page and add it to your project’s build path. You do not need to shade it into your addon — it will be present on the server at runtime.
Add Dimensions as a
compileOnly (Gradle) or provided (Maven) dependency so it is not bundled into your addon JAR.Resources
| Resource | Link |
|---|---|
| Javadocs | astaspasta.alwaysdata.net/javadocs |
| Source Code | github.com/xXastaspastaXx/Dimensions3 |
| SpigotMC | Dimensions — Custom Portals |
Utility Classes
Dimensions exposes three utility classes that you can use anywhere in your addon code:- DimensionsSettings — access the plugin’s configuration values at runtime.
- DimensionsUtils — general-purpose helper methods for working with portals and worlds.
- DimensionsDebbuger — log debug output through the Dimensions logging system.
Where to Go Next
Creating an Addon
Step-by-step guide to setting up your project, writing your main class, and registering your addon with ServiceLoader.
Example Addon
A complete, working addon that spawns explosion particles when a portal is ignited by a player with the right permission.
API Reference
Detailed documentation for CustomPortal, CompletePortal, and PortalGeometry — the core classes you will interact with.
Events
Reference for the three cancellable events Dimensions fires: use, ignite, and break.