Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prototik/cursedpublish
Plugin to automatically publish artifacts (mods) on the CurseForge portal directly from Gradle build lifecycle.
https://github.com/prototik/cursedpublish
Last synced: about 1 month ago
JSON representation
Plugin to automatically publish artifacts (mods) on the CurseForge portal directly from Gradle build lifecycle.
- Host: GitHub
- URL: https://github.com/prototik/cursedpublish
- Owner: Prototik
- License: cc0-1.0
- Created: 2024-01-08T18:48:10.000Z (12 months ago)
- Default Branch: develop
- Last Pushed: 2024-02-09T13:42:21.000Z (11 months ago)
- Last Synced: 2024-02-09T14:45:29.935Z (11 months ago)
- Language: Kotlin
- Size: 228 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cursed Publish plugin
[](https://gradle.org)
Plugin to automatically publish artifacts (mods) on the CurseForge portal directly from Gradle build lifecycle.
## Setup
[](https://plugins.gradle.org/plugin/rocks.aur.cursedpublish)
Kotlin buildscript
```kotlin
plugins {
id("rocks.aur.cursedpublish") version ""
}
```
Groovy buildscript
```groovy
plugins {
id 'rocks.aur.cursedpublish' version ''
}
```
## Configuration
```kotlin
cursedPublish {
projectId("") // numeric project id from mod page
apiToken("") // curseforge token from settings page
// You can use AbstractArchiveTask here to set file name and file source at the same type
file(tasks.jar) {
// Display name for mod file
displayName("MyCoolMod (Fabric)")
// Changelog
changelogMarkdown("# Some changelog for my CoolMod")
// Minecraft version
minecraft("1.20.4")
// ModLoader, usually only one
forge()
neoForge()
fabric()
quilt()
// Java version
java(17)
// Environment
client()
server()
// Release type
alpha()
beta()
release()
relations {
// Define dependencies to other curseforge projects
// You cannot declare one slug more than once
requiredDependency("")
optionalDependency("")
embeddedLibrary("")
incompatible("")
tool("")
}
additionalFile(tasks.sourcesJar) {
// the same as file, but you cannot define game versions
// (minecraft, modloader, java, environment) and nested files here
}
}
}
```
Plugin will create task for each top-level file (for example, when you register file with name `jar`, plugin will create task `curseforgeUploadJarFile` to upload file itself and all of its additional files).
All such tasks aggregated into `curseforgeUploadAllFiles` meta task to publish all declared files.