ModPublisherGradleExtension (modpublisher 2.2.2+snapshot.0 API)

java.lang.Object
- com.hypherionmc.modpublisher.plugin.ModPublisherGradleExtension

public class ModPublisherGradleExtension
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ModPublisherGradleExtension.AdditionalFile` Helper Class to add additional files with a custom Changelog and Display name
`static class`	`ModPublisherGradleExtension.ApiKeys`
`static class`	`ModPublisherGradleExtension.Dependencies` A Helper class to add dependencies with DSL
`class`	`ModPublisherGradleExtension.GithubConfig` Options related to publishing GitHub Releases
`static class`	`ModPublisherGradleExtension.ProxyConfig` Helper class to configure a proxy for the plugin to use

Constructor Summary

Constructors
Constructor and Description

ModPublisherGradleExtension(org.gradle.api.Project project)

Constructors
Constructor and Description
`ModPublisherGradleExtension(org.gradle.api.Project project)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalFile(org.gradle.api.Action<ModPublisherGradleExtension.AdditionalFile> file)` DSL support for adding a file with a custom display name and changelog
`void`	`addAdditionalFile(java.lang.Object... file)` Allow adding multiple additional files to be uploaded along with the main artifact
`void`	`addAdditionalFile(java.lang.Object file)` Allow adding a file to be uploaded along with the main artifact
`void`	`apiKeys(org.gradle.api.Action<ModPublisherGradleExtension.ApiKeys> action)` Helper Method to create the apiKeys extension with DSL
`void`	`copyFrom(ModPublisherGradleExtension other, org.gradle.api.tasks.SourceSet sourceSet)`
`void`	`curseDepends(org.gradle.api.Action<ModPublisherGradleExtension.Dependencies> action)` Helper method to create curseDepends with DSL
`void`	`github(org.gradle.api.Action<ModPublisherGradleExtension.GithubConfig> action)` Helper Method to create the github extension with DSL
`void`	`modrinthDepends(org.gradle.api.Action<ModPublisherGradleExtension.Dependencies> action)` Helper method to create modrinthDepends with DSL
`void`	`nightbloomDepends(org.gradle.api.Action<ModPublisherGradleExtension.Dependencies> action)` Helper method to create nightbloomDepends with DSL
`void`	`proxy(org.gradle.api.Action<ModPublisherGradleExtension.ProxyConfig> action)` Helper method to create the Proxy extension with DSL
`void`	`setCurseEnvironment(CurseEnvironment environment)` Allow adding Curse Environment with the `CurseEnvironment` helper enum
`void`	`setCurseEnvironment(java.lang.String environment)` Allow settings the Curse Environment with a String
`void`	`setGameVersions(java.lang.String... version)` Allow adding a list of game versions
`void`	`setGameVersions(java.lang.String version)` Allow adding a single game version, without a list
`void`	`setJavaVersions(java.lang.Object... version)` Add supported Java Versions, currently only used for Curseforge.
`void`	`setLoaders(ModLoader... loader)` Allow adding multiple mod loaders with the `ModLoader` helper enum
`void`	`setLoaders(ModLoader loader)` Allow adding a single loader with the `ModLoader` helper enum
`void`	`setLoaders(java.lang.String... loader)` Allow adding a list of modloaders
`void`	`setLoaders(java.lang.String loader)` Allow adding a single modloader without a list/array
`void`	`setPlatformArtifact(Platform platform, java.lang.Object artifact)` Helper method to override an upload artifact for a platform
`void`	`setPlatformArtifact(java.lang.String platform, java.lang.Object artifact)` Helper method to override an upload artifact for a platform
`void`	`setReleaseType(ReleaseType type)` Allows setting the release type with the `ReleaseType` helper enum

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ModPublisherGradleExtension
```
public ModPublisherGradleExtension(org.gradle.api.Project project)
```
- Method Detail
  - setPlatformArtifact
```
public void setPlatformArtifact(Platform platform,
                                java.lang.Object artifact)
```
    Helper method to override an upload artifact for a platform
    
    Parameters:
    
    platform - The Platform the artifact is for
    
    artifact - The artifact object to resolve
  - setPlatformArtifact
```
public void setPlatformArtifact(java.lang.String platform,
                                java.lang.Object artifact)
```
    Helper method to override an upload artifact for a platform
    
    Parameters:
    
    platform - The platform the override is for
    
    artifact - The artifact object to resolve
  - apiKeys
```
public void apiKeys(org.gradle.api.Action<ModPublisherGradleExtension.ApiKeys> action)
```
    Helper Method to create the apiKeys extension with DSL
    
    Parameters:
    
    action - The configured apiKeys DSL to apply
  - github
```
public void github(org.gradle.api.Action<ModPublisherGradleExtension.GithubConfig> action)
```
    Helper Method to create the github extension with DSL
    
    Parameters:
    
    action - The configured github DSL to apply
  - proxy
```
public void proxy(org.gradle.api.Action<ModPublisherGradleExtension.ProxyConfig> action)
```
    Helper method to create the Proxy extension with DSL
    
    Parameters:
    
    action - The configured Proxy DSL to apply
  - curseDepends
```
public void curseDepends(org.gradle.api.Action<ModPublisherGradleExtension.Dependencies> action)
```
    Helper method to create curseDepends with DSL
    
    Parameters:
    
    action - The configured curseDepends DSL to apply
  - modrinthDepends
```
public void modrinthDepends(org.gradle.api.Action<ModPublisherGradleExtension.Dependencies> action)
```
    Helper method to create modrinthDepends with DSL
    
    Parameters:
    
    action - The configured modrinthDepends DSL to apply
  - nightbloomDepends
```
public void nightbloomDepends(org.gradle.api.Action<ModPublisherGradleExtension.Dependencies> action)
```
    Helper method to create nightbloomDepends with DSL
    
    Parameters:
    
    action - The configured nightbloomDepends DSL to apply
  - setGameVersions
```
public void setGameVersions(java.lang.String version)
```
    Allow adding a single game version, without a list
    
    Parameters:
    
    version - The game version to add
  - setGameVersions
```
public void setGameVersions(java.lang.String... version)
```
    Allow adding a list of game versions
    
    Parameters:
    
    version - The game versions to add
  - setLoaders
```
public void setLoaders(java.lang.String loader)
```
    Allow adding a single modloader without a list/array
    
    Parameters:
    
    loader - The loader to add
  - setLoaders
```
public void setLoaders(java.lang.String... loader)
```
    Allow adding a list of modloaders
    
    Parameters:
    
    loader - The loaders to add
  - setLoaders
```
public void setLoaders(ModLoader loader)
```
    Allow adding a single loader with the ModLoader helper enum
    
    Parameters:
    
    loader - The loader to add
  - setLoaders
```
public void setLoaders(ModLoader... loader)
```
    Allow adding multiple mod loaders with the ModLoader helper enum
    
    Parameters:
    
    loader - The loaders to add
  - setJavaVersions
```
public void setJavaVersions(java.lang.Object... version)
```
    Add supported Java Versions, currently only used for Curseforge.
    Accepts any object that can be converted to a JavaVersion using JavaVersion.toVersion(Object).
    Strings will have the optional prefix "Java " removed before being parsed, to support versions formatted as "Java 8".
    Example: setJavaVersions(8, JavaVersion.VERSION_11, "16", "Java 17")
    
    Parameters:
    
    version - Version or Versions to add.
  - setCurseEnvironment
```
public void setCurseEnvironment(java.lang.String environment)
```
    Allow settings the Curse Environment with a String
    
    Parameters:
    
    environment - The curse environment
  - setCurseEnvironment
```
public void setCurseEnvironment(CurseEnvironment environment)
```
    Allow adding Curse Environment with the CurseEnvironment helper enum
    
    Parameters:
    
    environment - The Curse Environment to add
  - setReleaseType
```
public void setReleaseType(ReleaseType type)
```
    Allows setting the release type with the ReleaseType helper enum
    
    Parameters:
    
    type - The release type to set
  - addAdditionalFile
```
public void addAdditionalFile(java.lang.Object file)
```
    Allow adding a file to be uploaded along with the main artifact
    
    Parameters:
    
    file - The file
  - addAdditionalFile
```
public void addAdditionalFile(java.lang.Object... file)
```
    Allow adding multiple additional files to be uploaded along with the main artifact
    
    Parameters:
    
    file - The files
  - addAdditionalFile
```
public void addAdditionalFile(org.gradle.api.Action<ModPublisherGradleExtension.AdditionalFile> file)
```
    DSL support for adding a file with a custom display name and changelog
    
    Parameters:
    
    file - The DSL object containing the file data
  - copyFrom
```
public void copyFrom(ModPublisherGradleExtension other,
                     org.gradle.api.tasks.SourceSet sourceSet)
```

Class ModPublisherGradleExtension

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModPublisherGradleExtension

Method Detail

setPlatformArtifact

setPlatformArtifact

apiKeys

github

proxy

curseDepends

modrinthDepends

nightbloomDepends

setGameVersions

setGameVersions

setLoaders

setLoaders

setLoaders

setLoaders

setJavaVersions

setCurseEnvironment

setCurseEnvironment

setReleaseType

addAdditionalFile

addAdditionalFile

addAdditionalFile

copyFrom