BaseProject

A Gradle convention plugin for streamlined project setup and publishing.

Contact

If you encounter any issues, please report them on the issue tracker. If you just want to talk or need help with BaseProject, feel free to join my Discord.

Basic Setup

The functions provided by this plugin read their configuration from properties in your gradle.properties file. Set the properties for the features you use; anything the plugin does not find is simply skipped (except where a property is explicitly required, such as jvm_version).

Kotlin DSL Example:

Add the plugin to your settings.gradle.kts file:

pluginManagement {
    repositories {
        gradlePluginPortal()
    }

    plugins {
        id("de.florianreuth.baseproject") version "<version>"
    }
}

Update the build.gradle.kts file:

import de.florianreuth.baseproject.*

plugins {
    id("de.florianreuth.baseproject")
}

// Sets up common configurations: project metadata, repositories, Java toolchain, and compiler options
setupProject()

Set project properties in the gradle.properties file:

# Required by setupProject()
jvm_version=17
# Optional metadata; each is only applied if present
project_group=com.example
project_name=ExampleProject
project_version=1.0.0-SNAPSHOT
project_description=Example Java project.

---

Groovy DSL Example:

Add the plugin to your settings.gradle file:

pluginManagement {
    repositories {
        gradlePluginPortal()
    }

    plugins {
        id 'de.florianreuth.baseproject' version '<version>'
    }
}

Update the build.gradle file:

plugins {
    id 'de.florianreuth.baseproject'
}

// Sets up common configurations: project metadata, repositories, Java toolchain, and compiler options
setupProject()

Set project properties in the gradle.properties file:

# Required by setupProject()
jvm_version=17
# Optional metadata; each is only applied if present
project_group=com.example
project_name=ExampleProject
project_version=1.0.0-SNAPSHOT
project_description=Example Java project.

---

Publishing

setupPublishing() configures a Maven publication (with signing) and registers the GitHub, Reposilite, and Sonatype ( Maven Central) repositories. A repository is only activated when its credentials are present, so you can configure just the ones you need.

Kotlin DSL Example:

Add the following to your build.gradle.kts (below the setupProject call):

import de.florianreuth.baseproject.setupPublishing

// Configures the publication, signing, and the GitHub / Reposilite / Sonatype repositories
setupPublishing()

Groovy DSL Example:

Add the following to your build.gradle (below the setupProject call):

// Configures the publication, signing, and the GitHub / Reposilite / Sonatype repositories
setupPublishing()

Publishing to the ViaVersion repository instead? Use setupViaPublishing(), which sets the appropriate owner and license before publishing to GitHub and the Via repository.

Publishing Metadata

Set the following in your project's gradle.properties:

publish_owner_id=florianreuth
publish_owner_name=<full name>
publish_owner_mail=<contact mail>
# Optional; defaults to Apache-2.0
# publish_license=Apache-2.0
# publish_license_url=https://www.apache.org/licenses/LICENSE-2.0

The GitHub account and repository are used to derive the publication owner id, distribution URL, and license URL automatically.

Signing and Publishing Credentials

Add credentials to the gradle.properties in your user .gradle folder (keep them out of the repository). Only the repositories whose credentials are present get activated:

# Signing (publications are signed when these are present)
signing.keyId=<the last 8 digits of your key id>
signing.password=<your key password>
signing.secretKeyRingFile=<path to your keyring file>
# Sonatype / Maven Central
sonatypeToken=<your Sonatype token>
sonatypePassword=<your Sonatype token password>
# Reposilite
reposiliteUsername=<your Reposilite username>
reposilitePassword=<your Reposilite password>

---

Fabric Setup

setupFabric() applies Fabric Loom, wires up the Fabric loader and Minecraft dependencies, expands fabric.mod.json, and — if a <project-name>.accesswidener file is present under src/main/resources — loads it automatically.

Kotlin DSL Example:

Add the following to your build.gradle.kts (below the setupProject call):

import de.florianreuth.baseproject.integration.setupFabric

setupFabric()

Set the required versions in gradle.properties:

# Required
minecraft_version=1.21.5
fabric_loader_version=0.16.14
# Optional
# fabric_api_version=0.119.2+1.21.5
# fabric_kotlin_version=1.13.1+kotlin.2.1.20   (added automatically when the Kotlin plugin is applied)
# supported_minecraft_versions=1.21.4,1.21.5

---

Groovy DSL Example:

Add the following to your build.gradle (below the setupProject call):

setupFabric()

Set the required versions in gradle.properties:

# Required
minecraft_version=1.21.5
fabric_loader_version=0.16.14
# Optional
# fabric_api_version=0.119.2+1.21.5
# fabric_kotlin_version=1.13.1+kotlin.2.1.20
# supported_minecraft_versions=1.21.4,1.21.5

---

Moving On

The plugin ships additional utilities. A couple of the common ones:

Shaded dependencies

Embed dependencies directly into the output JAR:

Kotlin DSL

import de.florianreuth.baseproject.core.configureShadedDependencies

val library = configureShadedDependencies()

dependencies {
    library("group:artifact:version")
}

Groovy DSL

def library = configureShadedDependencies()

dependencies {
    library 'group:artifact:version'
}

Application JAR

Set the Main-Class manifest attribute from the application_main property:

import de.florianreuth.baseproject.core.configureApplication

configureApplication()

application_main=com.example.Main

configureApplication() no longer excludes the run/ folder from the IntelliJ IDEA model. If you want that, call excludeRunFolder() (from de.florianreuth.baseproject.integration) explicitly.

For more utilities and detailed documentation, please refer to the Kotlin files and methods in the plugin, which include detailed KotlinDoc comments.