mod-publish-plugin - GitLite

KO | EN

gitlite — search

#hacktoberfest #typescript #golang #android #machine-learning #rust #macos #nodejs #cli #kubernetes #vue #awesome-list #pytorch #mcp

mod-publish-plugin

(★ 116)

A Gradle plugin to publish mods to a range of destinations

File Explorer

Download Latest Version (.zip)

- - docs.yml
  - publish.yml
  - test.yml
- - _meta.json
  - getting_started.mdx
  - github_actions.mdx
  - index.mdx
  - multi_platform.mdx
  - options.mdx
  - shared_options.mdx
- .gitignore
- next-env.d.ts
- next.config.js
- package-lock.json
- package.json
- theme.config.tsx
- tsconfig.json
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.gitattributes
.gitignore
build.gradle.kts
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle.kts

# Installation Guide

1. Get the code

git clone https://github.com/modmuss50/mod-publish-plugin

Downloads the entire project code from GitHub to your computer.

cd mod-publish-plugin

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mod Publish Plugin
A modern Gradle plugin to publish mods to a range of destinations.

Please make sure to report all issues, and any suggestions on this GitHub repo!

## Basic usage
Visit the [docs site](https://modmuss50.github.io/mod-publish-plugin/) for more detailed instructions.

Add to your Gradle plugins block:

#### Groovy
```groovy
plugins {
  id "me.modmuss50.mod-publish-plugin" version "2.2.0"
}
```
#### Kotlin
```kotlin
plugins {
  id("me.modmuss50.mod-publish-plugin") version "2.2.0"
}
```

It is recommended to specify an exact version number to prevent unwanted breakages to your build script.

Basic example to publish a jar to CurseForge, Modrinth and GitHub from a Fabric project:
#### Groovy
```groovy
publishMods {
    file = remapJar.archiveFile
    changelog = "Hello!"
    type = STABLE
    modLoaders.add("fabric")

curseforge {
        projectId = "123456"
        projectSlug = "example-project" // Required for discord webhook
        accessToken = providers.environmentVariable("CURSEFORGE_TOKEN")
        minecraftVersions.add("1.20.1")
        client = true
        server = true
        requires("fabric-api")
    }
    modrinth {
        projectId = "abcdef"
        accessToken = providers.environmentVariable("MODRINTH_TOKEN")
        minecraftVersions.add("1.20.1")
    }
    github {
        repository = "test/example"
        accessToken = providers.environmentVariable("GITHUB_TOKEN")
        commitish = "main"
    }
    discord {
        webhookUrl = providers.environmentVariable("DISCORD_WEBHOOK")
    }
}
```
#### Kotlin
```kotlin
publishMods {
    file.set(remapJar.archiveFile)
    changelog.set("Hello!")
    type.set(STABLE)
    modLoaders.add("fabric")

curseforge {
        projectId.set("123456")
        projectSlug.set("example-project") // Required for discord webhook
        accessToken.set(providers.environmentVariable("CURSEFORGE_TOKEN"))
        minecraftVersions.add("1.20.1")
        client.set(true)
        server.set(true)
        requires("fabric-api")
    }
    modrinth {
        projectId.set("abcdef")
        accessToken.set(providers.environmentVariable("MODRINTH_TOKEN"))
        minecraftVersions.add("1.20.1")
    }
    github {
        repository.set("test/example")
        accessToken.set(providers.environmentVariable("GITHUB_TOKEN"))
        commitish.set("main")
    }
    discord {
        webhookUrl.set(providers.environmentVariable("DISCORD_WEBHOOK"))
    }
}
```

Run the `publishMods` task to publish to all configured destinations.

When publishing to CurseForge, set at least one of `client` or `server` to `true`.

Visit the [docs site](https://modmuss50.github.io/mod-publish-plugin/) for more detailed instructions.