|
| 1 | +# Mod Dev Catalog |
| 2 | + |
| 3 | +A Gradle **settings plugin** that provides curated version catalogs for Minecraft mod development. Apply it once in `settings.gradle.kts` to get pre-configured, versioned library definitions for popular mods — no more copy-pasting Maven coordinates. |
| 4 | + |
| 5 | +## Supported Catalogs |
| 6 | + |
| 7 | +| Catalog ID | Minecraft | Mod Loader | |
| 8 | +|-------------------|-----------|---------------------| |
| 9 | +| `1.20.1-forge` | 1.20.1 | Forge 47.4.3 | |
| 10 | +| `1.21.1-neoforge` | 1.21.1 | NeoForge | |
| 11 | + |
| 12 | +## Setup |
| 13 | + |
| 14 | +### 1. Apply the plugin in `settings.gradle.kts` |
| 15 | + |
| 16 | +```kotlin |
| 17 | +plugins { |
| 18 | + id("com.morphismmc.mod-dev-catalog") version "26.3.25" |
| 19 | +} |
| 20 | + |
| 21 | +modDevCatalog { |
| 22 | + catalog("1.21.1-neoforge") // registers as catalog named "mods" |
| 23 | +} |
| 24 | +``` |
| 25 | + |
| 26 | +The plugin is available from the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/com.morphismmc.mod-dev-catalog) and the MorphismMC Maven repository (`https://maven.morphismmc.com/releases`). |
| 27 | + |
| 28 | +### 2. Use dependencies in `build.gradle.kts` |
| 29 | + |
| 30 | +The catalog is registered under the name `mods` by default. Alias kebab-case names (`jei-api`) become dot-accessor chains (`mods.jei.api`). |
| 31 | + |
| 32 | +```kotlin |
| 33 | +dependencies { |
| 34 | + // Single library |
| 35 | + compileOnly(mods.jei.api) |
| 36 | + |
| 37 | + // Bundle (group of related libraries) |
| 38 | + compileOnly(mods.bundles.jei) |
| 39 | + runtimeOnly(mods.bundles.rei) |
| 40 | +} |
| 41 | +``` |
| 42 | + |
| 43 | +To use a different catalog name, pass a second argument: |
| 44 | + |
| 45 | +```kotlin |
| 46 | +modDevCatalog { |
| 47 | + catalog("1.21.1-neoforge", "modlibs") |
| 48 | +} |
| 49 | +// then: modlibs.jei.api, modlibs.bundles.jei, etc. |
| 50 | +``` |
| 51 | + |
| 52 | +The plugin also automatically configures exclusive-content repository rules for each Maven repository, so Gradle resolves each group from the correct source. |
| 53 | + |
| 54 | +## Available Libraries |
| 55 | + |
| 56 | +### `1.21.1-neoforge` |
| 57 | + |
| 58 | +| Alias | Library | |
| 59 | +|---|---| |
| 60 | +| `jei.api` | JEI NeoForge API | |
| 61 | +| `jei.impl` | JEI NeoForge | |
| 62 | +| `rei.api` | REI NeoForge API | |
| 63 | +| `rei.impl` | REI NeoForge | |
| 64 | +| `rei.plugin` | REI Default Plugin NeoForge | |
| 65 | +| `patchouli` | Patchouli | |
| 66 | +| `emi` | EMI | |
| 67 | +| `jade` | Jade | |
| 68 | +| `ae2` | Applied Energistics 2 | |
| 69 | +| `kjs` | KubeJS NeoForge | |
| 70 | +| **`bundles.jei`** | jei.api + jei.impl | |
| 71 | +| **`bundles.rei`** | rei.api + rei.impl + rei.plugin | |
| 72 | + |
| 73 | +### `1.20.1-forge` |
| 74 | + |
| 75 | +| Alias | Library | |
| 76 | +|---|---| |
| 77 | +| `jei.api.common` | JEI Common API | |
| 78 | +| `jei.api.forge` | JEI Forge API | |
| 79 | +| `jei.impl` | JEI Forge | |
| 80 | +| `rei.api` | REI Forge API | |
| 81 | +| `rei.impl` | REI Forge | |
| 82 | +| `rei.plugin` | REI Default Plugin Forge | |
| 83 | +| `architectury` | Architectury Forge | |
| 84 | +| `jade` | Jade | |
| 85 | +| `modernui` | Modern UI | |
| 86 | +| `jecharacters` | Just Enough Characters | |
| 87 | +| `placebo` | Placebo | |
| 88 | +| `hostile.neural.networks` | Hostile Neural Networks | |
| 89 | +| `emi` | EMI | |
| 90 | +| `ftb.library` | FTB Library | |
| 91 | +| `appeng` | Applied Energistics 2 | |
| 92 | +| `mekanism` | Mekanism | |
| 93 | +| **`bundles.jei`** | jei.api.common + jei.api.forge + jei.impl | |
| 94 | +| **`bundles.rei`** | rei.api + rei.impl + rei.plugin | |
| 95 | + |
| 96 | +## License |
| 97 | + |
| 98 | +[MIT](LICENSE) |
0 commit comments