Blame
|
1 | # Module Reference |
||||||
| 2 | ||||||||
| 3 | ||||||||
| 4 | > **Documentation baseline:** VoxelCore `main` at `452b569` · 14 September 2026. |
|||||||
| 5 | > **Repository:** [https://github.com/VoxelHorizons/VoxelCore](https://github.com/VoxelHorizons/VoxelCore) |
|||||||
| 6 | ||||||||
| 7 | ||||||||
| 8 | The root Maven reactor currently contains nine modules. |
|||||||
| 9 | ||||||||
| 10 | | Module | Responsibility | |
|||||||
| 11 | |---|---| |
|||||||
| 12 | | `voxelcore-common` | Content IDs, authoring models, parsing/compilation, runtime snapshots, render allocations, common item/platform contracts. | |
|||||||
| 13 | | `voxelcore-pack` | Deterministic Java resource-pack compilation and exact pack-target profiles. | |
|||||||
| 14 | | `voxelcore-plugin` | Bukkit plugin lifecycle, configuration migration, command framework, `PackManager`, platform discovery. | |
|||||||
| 15 | | `voxelcore-v1_12` | 1.12.x–1.13.x legacy family, legacy NBT identity and distribution packaging. | |
|||||||
| 16 | | `voxelcore-v1_14` | 1.14–1.19.3 family, PDC/numeric CMD path and distribution packaging. | |
|||||||
| 17 | | `voxelcore-v1_19_4` | 1.19.4–1.20.4 family boundary. | |
|||||||
| 18 | | `voxelcore-v1_20_5` | 1.20.5–1.21.3 data-component-era family. | |
|||||||
| 19 | | `voxelcore-v1_21_4` | Exact 1.21.4 structured CMD/item-model implementation. | |
|||||||
| 20 | | `voxelcore-v26_2` | Exact 26.2 Paper implementation compiled with Java 25. | |
|||||||
| 21 | ||||||||
| 22 | ## `voxelcore-common` package map |
|||||||
| 23 | ||||||||
| 24 | - `content.ContentID` — canonical namespaced identity. |
|||||||
| 25 | - `content.load.*` — deterministic pack/file loading and strict YAML parsing. |
|||||||
| 26 | - `content.compile.*` — inheritance resolution and compilation. |
|||||||
| 27 | - `content.item.*` — raw and compiled item models. |
|||||||
| 28 | - `content.render.*` — persistent render allocation registry/store and structured indices. |
|||||||
| 29 | - `content.runtime.*` — snapshot publication and safe reload result/runtime. |
|||||||
| 30 | - `item.ItemManager` — definition lookup, item creation and identity lookup through the active snapshot. |
|||||||
| 31 | - `platform.*` — version, capabilities, provider/adapter contracts. |
|||||||
| 32 | - `platform.item.*` — item platform adapter and metadata flag support. |
|||||||
| 33 | ||||||||
| 34 | ## `voxelcore-plugin` |
|||||||
| 35 | ||||||||
| 36 | The plugin module wires the pieces together in `org.voxelhorizons.VoxelCore`. Startup performs config migration, platform selection, content load, allocation reconciliation, platform validation, snapshot publication, manager construction and command registration before emitting `VOXELCORE_READY`. |
|||||||
| 37 | ||||||||
| 38 | ## Version module service discovery |
|||||||
| 39 | ||||||||
| 40 | Each version module registers an `org.voxelhorizons.platform.PlatformProvider` in `META-INF/services`. This keeps version-specific classes isolated from common code and lets `VersionAdapterFactory` select a matching provider at runtime. |
|||||||