Index (Mc-Mod-Publisher 1.0.0 API)

A C D E F G H I L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

apply(Project) - Method in class io.github.smootheez.McModPublisherPlugin: Applies the plugin to the target Gradle project by registering the extension and creating the publishing tasks.

C

changelog() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns the value of the changelog record component.
changelog() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the changelog record component.
changelogType() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns the value of the changelogType record component.
ChangelogType - Enum Class in io.github.smootheez.curseforge: Defines the supported changelog content formats used by curseforge.
client - Variable in class io.github.smootheez.Publisher: HTTP client used to send HTTP requests to external publishing platforms.
CLIENT - Enum constant in enum class io.github.smootheez.curseforge.EnvironmentType: Indicates that the mod is intended to run on the client environment.
Constants - Class in io.github.smootheez: Holds application-wide constant values used throughout the Mod Publisher service.
curseforge(Action<CurseforgeConfig>) - Method in class io.github.smootheez.McModPublisherExtension: Applies user configuration to the CurseForge publishing settings.
CurseforgeConfig - Class in io.github.smootheez.curseforge: Configuration model for publishing projects to CurseForge.
CurseforgeConfig(ObjectFactory) - Constructor for class io.github.smootheez.curseforge.CurseforgeConfig: Constructs a new CurseForge configuration block.
CurseforgeDependency - Class in io.github.smootheez.curseforge: Represents a CurseForge dependency declaration within a publisher configuration.
CurseforgeDependency(String) - Constructor for class io.github.smootheez.curseforge.CurseforgeDependency: Constructs a dependency instance using its container-managed name.
CurseforgeMetadata - Record Class in io.github.smootheez.curseforge: Represents the metadata payload sent when uploading a file to CurseForge.
CurseforgeMetadata(String, ChangelogType, String, List<Integer>, String, boolean, Projects) - Constructor for record class io.github.smootheez.curseforge.CurseforgeMetadata: Creates an instance of a CurseforgeMetadata record class.
CurseforgePublisher - Class in io.github.smootheez.curseforge: Handles publishing mod files to CurseForge using the CurseForge upload API.
CurseforgePublisher(Project, McModPublisherExtension, OkHttpClient) - Constructor for class io.github.smootheez.curseforge.CurseforgePublisher: Constructs a new CurseForge publisher instance.

D

DATA - Static variable in class io.github.smootheez.Constants: JSON key for root-level file data.
date() - Method in record class io.github.smootheez.modrinth.GameVersionTag: Returns the value of the date record component.
dependencies - Variable in class io.github.smootheez.PublisherConfig: Container holding all declared dependency relationships for this publisher, created using Gradle's NamedDomainObjectContainer.
dependencies() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the dependencies record component.
dependencies(Action<NamedDomainObjectContainer<CurseforgeDependency>>) - Method in class io.github.smootheez.curseforge.CurseforgeConfig: Provides access to the dependency container for configuration.
dependencies(Action<NamedDomainObjectContainer<ModrinthDependency>>) - Method in class io.github.smootheez.modrinth.ModrinthConfig: Applies the provided configuration action to the Modrinth dependency container.
dependencies(Action<NamedDomainObjectContainer<T>>) - Method in class io.github.smootheez.PublisherConfig: Provides access to the dependency container for modification.
DependencyMetadata - Record Class in io.github.smootheez.modrinth: Represents a single dependency entry used when publishing metadata to external mod distribution platforms such as CurseForge or Modrinth.
DependencyMetadata(String, DependencyType) - Constructor for record class io.github.smootheez.modrinth.DependencyMetadata: Creates an instance of a DependencyMetadata record class.
dependencyType() - Method in record class io.github.smootheez.modrinth.DependencyMetadata: Returns the value of the dependencyType record component.
DependencyType - Enum Class in io.github.smootheez.modrinth: Represents the type of dependency relationship used when publishing metadata to mod distribution platforms such as Modrinth or CurseForge.
displayName() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns the value of the displayName record component.

E

embedded(String) - Method in class io.github.smootheez.curseforge.CurseforgeConfig: Declares an embedded library dependency.
embedded(String) - Method in class io.github.smootheez.modrinth.ModrinthConfig: Creates an embedded dependency entry for the given Modrinth project ID.
embedded(S) - Method in class io.github.smootheez.PublisherConfig: Declares an embedded dependency (e.g., libraries bundled with the mod).
EMBEDDED - Enum constant in enum class io.github.smootheez.modrinth.DependencyType: Indicates that the dependency is bundled or embedded directly inside the mod’s own files, meaning users do not need to install it separately.
EMBEDDED_LIBRARY - Enum constant in enum class io.github.smootheez.curseforge.RelationType: Indicates that the referenced project is bundled directly inside this project as an embedded library.
EnvironmentType - Enum Class in io.github.smootheez.curseforge: Defines the runtime environment targets for a mod when publishing to platforms that distinguish between client-side and server-side compatibility.
equals(Object) - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.smootheez.curseforge.GameVersionTag: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.smootheez.curseforge.Projects: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.smootheez.curseforge.ProjectsMetadata: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.smootheez.modrinth.DependencyMetadata: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.smootheez.modrinth.GameVersionTag: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Indicates whether some other object is "equal to" this one.
extension - Variable in class io.github.smootheez.Publisher: Global extension containing configuration values supplied by users via Gradle DSL.

F

FABRIC - Enum constant in enum class io.github.smootheez.LoaderType: Indicates compatibility with the Fabric mod loader.
FailedFetchGameVersionsException - Exception Class in io.github.smootheez.exception: Exception thrown when the publisher fails to retrieve the list of valid game versions from the CurseForge API.
FailedFetchGameVersionsException(String) - Constructor for exception class io.github.smootheez.exception.FailedFetchGameVersionsException: Creates a new exception indicating that fetching game versions has failed.
FailedFileUploadException - Exception Class in io.github.smootheez.exception: Exception thrown when an upload attempt to a publishing platform (e.g., CurseForge or Modrinth) fails.
FailedFileUploadException(String) - Constructor for exception class io.github.smootheez.exception.FailedFileUploadException: Constructs a new exception indicating that a file upload operation did not complete successfully.
featured() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the featured record component.
fileParts() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the fileParts record component.
FORGE - Enum constant in enum class io.github.smootheez.LoaderType: Indicates compatibility with the Forge mod loader.

G

gameVersions() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns the value of the gameVersions record component.
gameVersions() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the gameVersions record component.
GameVersionTag - Record Class in io.github.smootheez.curseforge: Represents a game version entry returned by the CurseForge API.
GameVersionTag - Record Class in io.github.smootheez.modrinth: Represents a game version entry retrieved from an external API such as Modrinth.
GameVersionTag(int, int, String, String) - Constructor for record class io.github.smootheez.curseforge.GameVersionTag: Creates an instance of a GameVersionTag record class.
GameVersionTag(String, String, String, boolean) - Constructor for record class io.github.smootheez.modrinth.GameVersionTag: Creates an instance of a GameVersionTag record class.
gameVersionTypeId() - Method in record class io.github.smootheez.curseforge.GameVersionTag: Returns the value of the gameVersionTypeId record component.
GSON - Static variable in class io.github.smootheez.Publisher: Shared Gson instance for serializing and deserializing JSON payloads.

H

hashCode() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns a hash code value for this object.
hashCode() - Method in record class io.github.smootheez.curseforge.GameVersionTag: Returns a hash code value for this object.
hashCode() - Method in record class io.github.smootheez.curseforge.Projects: Returns a hash code value for this object.
hashCode() - Method in record class io.github.smootheez.curseforge.ProjectsMetadata: Returns a hash code value for this object.
hashCode() - Method in record class io.github.smootheez.modrinth.DependencyMetadata: Returns a hash code value for this object.
hashCode() - Method in record class io.github.smootheez.modrinth.GameVersionTag: Returns a hash code value for this object.
hashCode() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns a hash code value for this object.
HTML - Enum constant in enum class io.github.smootheez.curseforge.ChangelogType: Changelog provided as HTML content.

I

id() - Method in record class io.github.smootheez.curseforge.GameVersionTag: Returns the value of the id record component.
incompatible(String) - Method in class io.github.smootheez.curseforge.CurseforgeConfig: Declares an incompatible CurseForge dependency.
incompatible(String) - Method in class io.github.smootheez.modrinth.ModrinthConfig: Creates an incompatible dependency entry for the given Modrinth project ID.
incompatible(S) - Method in class io.github.smootheez.PublisherConfig: Declares an incompatible dependency.
INCOMPATIBLE - Enum constant in enum class io.github.smootheez.curseforge.RelationType: Indicates that the referenced project conflicts with this one.
INCOMPATIBLE - Enum constant in enum class io.github.smootheez.modrinth.DependencyType: Marks a dependency as incompatible.
io.github.smootheez - package io.github.smootheez
io.github.smootheez.curseforge - package io.github.smootheez.curseforge
io.github.smootheez.exception - package io.github.smootheez.exception
io.github.smootheez.modrinth - package io.github.smootheez.modrinth
isMarkedForManualRelease() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns the value of the isMarkedForManualRelease record component.

L

loaders() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the loaders record component.
LoaderType - Enum Class in io.github.smootheez: Represents the supported mod loader ecosystems used when determining compatibility for publication on platforms such as Modrinth or CurseForge.

M

major() - Method in record class io.github.smootheez.modrinth.GameVersionTag: Returns the value of the major record component.
MARKDOWN - Enum constant in enum class io.github.smootheez.curseforge.ChangelogType: Changelog written using Markdown syntax.
McModPublisherExtension - Class in io.github.smootheez: Gradle extension that configures publishing options for Minecraft mods to platforms such as CurseForge and Modrinth.
McModPublisherExtension(Project, ObjectFactory) - Constructor for class io.github.smootheez.McModPublisherExtension: Creates the extension and initializes file collection and platform configurations.
McModPublisherPlugin - Class in io.github.smootheez: Gradle plugin that registers tasks and configuration required to publish Minecraft mods to Modrinth and CurseForge.
McModPublisherPlugin() - Constructor for class io.github.smootheez.McModPublisherPlugin
MEDIA_TYPE_JAR - Static variable in class io.github.smootheez.Constants: The JAR media type used when uploading mod artifacts.
MEDIA_TYPE_JSON - Static variable in class io.github.smootheez.Constants: The JSON media type used for request and response bodies.
METADATA - Static variable in class io.github.smootheez.Constants: JSON key for metadata blocks associated with uploads.
modrinth(Action<ModrinthConfig>) - Method in class io.github.smootheez.McModPublisherExtension: Applies user configuration to the Modrinth publishing settings.
ModrinthConfig - Class in io.github.smootheez.modrinth: Configuration block for publishing mods to Modrinth.
ModrinthConfig(ObjectFactory) - Constructor for class io.github.smootheez.modrinth.ModrinthConfig: Creates a new Modrinth configuration instance and initializes the dependency container.
ModrinthDependency - Class in io.github.smootheez.modrinth: Represents a single dependency entry for a Modrinth project upload.
ModrinthDependency(String) - Constructor for class io.github.smootheez.modrinth.ModrinthDependency: Constructs a Modrinth dependency wrapper with the given internal name.
ModrinthMetadata - Record Class in io.github.smootheez.modrinth: Represents the complete metadata payload required when uploading a version to Modrinth.
ModrinthMetadata(String, String, String, String, List<String>, List<LoaderType>, String, List<DependencyMetadata>, boolean, String, List<String>) - Constructor for record class io.github.smootheez.modrinth.ModrinthMetadata: Creates an instance of a ModrinthMetadata record class.
ModrinthPublisher - Class in io.github.smootheez.modrinth: Publishes mod versions to Modrinth using their official API.
ModrinthPublisher(Project, McModPublisherExtension, OkHttpClient) - Constructor for class io.github.smootheez.modrinth.ModrinthPublisher: Constructs a new ModrinthPublisher.

N

name() - Method in record class io.github.smootheez.curseforge.GameVersionTag: Returns the value of the name record component.
name() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the name record component.
NEOFORGE - Enum constant in enum class io.github.smootheez.LoaderType: Indicates compatibility with the NeoForge mod loader.

O

optional(String) - Method in class io.github.smootheez.curseforge.CurseforgeConfig: Declares an optional CurseForge dependency.
optional(String) - Method in class io.github.smootheez.modrinth.ModrinthConfig: Creates an optional dependency entry for the given Modrinth project ID.
optional(S) - Method in class io.github.smootheez.PublisherConfig: Declares an optional dependency.
OPTIONAL - Enum constant in enum class io.github.smootheez.modrinth.DependencyType: Indicates that the dependency is optional.
OPTIONAL_DEPENDENCY - Enum constant in enum class io.github.smootheez.curseforge.RelationType: Indicates that the referenced project is an optional dependency.

P

project - Variable in class io.github.smootheez.Publisher: The current Gradle project, used for logging and access to build information.
projectId() - Method in record class io.github.smootheez.modrinth.DependencyMetadata: Returns the value of the projectId record component.
projectId() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the projectId record component.
projects() - Method in record class io.github.smootheez.curseforge.Projects: Returns the value of the projects record component.
Projects - Record Class in io.github.smootheez.curseforge: Container for a list of project relation metadata entries.
Projects() - Constructor for record class io.github.smootheez.curseforge.Projects: Creates a Projects instance with an empty list by default.
Projects(List<ProjectsMetadata>) - Constructor for record class io.github.smootheez.curseforge.Projects: Creates an instance of a Projects record class.
ProjectsMetadata - Record Class in io.github.smootheez.curseforge: Represents a single relationship entry linking this upload to another project.
ProjectsMetadata(String, RelationType) - Constructor for record class io.github.smootheez.curseforge.ProjectsMetadata: Creates an instance of a ProjectsMetadata record class.
publish() - Method in class io.github.smootheez.curseforge.CurseforgePublisher: Publishes all configured files to CurseForge.
publish() - Method in class io.github.smootheez.modrinth.ModrinthPublisher: Executes the publishing process to Modrinth.
publish() - Method in class io.github.smootheez.Publisher: Executes the publishing workflow for a specific platform.
Publisher - Class in io.github.smootheez: Base abstraction for all publishing implementations within the Mc-Mod-Publisher Gradle plugin.
Publisher() - Constructor for class io.github.smootheez.Publisher
PublisherConfig<T,S> - Class in io.github.smootheez: Base configuration class for all publisher integrations (e.g., Modrinth, CurseForge).
PublisherConfig(ObjectFactory, Class<T>) - Constructor for class io.github.smootheez.PublisherConfig: Creates a new publisher configuration and initializes the dependency container.

Q

QUILT - Enum constant in enum class io.github.smootheez.LoaderType: Indicates compatibility with the Quilt mod loader.

R

relations() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns the value of the relations record component.
relationType() - Method in record class io.github.smootheez.curseforge.ProjectsMetadata: Returns the value of the relationType record component.
RelationType - Enum Class in io.github.smootheez.curseforge: Defines the possible relationship types between a project and another referenced project or resource.
releaseChannel() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the releaseChannel record component.
releaseType() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns the value of the releaseType record component.
required(String) - Method in class io.github.smootheez.curseforge.CurseforgeConfig: Declares a required CurseForge dependency.
required(String) - Method in class io.github.smootheez.modrinth.ModrinthConfig: Creates a required dependency entry for the given Modrinth project ID.
required(S) - Method in class io.github.smootheez.PublisherConfig: Declares a required dependency.
REQUIRED - Enum constant in enum class io.github.smootheez.modrinth.DependencyType: Indicates that the dependency is mandatory.
REQUIRED_DEPENDENCY - Enum constant in enum class io.github.smootheez.curseforge.RelationType: Indicates that the referenced project is a required dependency.

S

SERVER - Enum constant in enum class io.github.smootheez.curseforge.EnvironmentType: Indicates that the mod is intended to run on a dedicated or integrated server.
slug() - Method in record class io.github.smootheez.curseforge.GameVersionTag: Returns the value of the slug record component.
slug() - Method in record class io.github.smootheez.curseforge.ProjectsMetadata: Returns the value of the slug record component.
status() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the status record component.

T

TEXT - Enum constant in enum class io.github.smootheez.curseforge.ChangelogType: Changelog provided as plain text.
TIMEOUT - Static variable in class io.github.smootheez.Constants: Default request timeout duration for network operations.
tool(String) - Method in class io.github.smootheez.curseforge.CurseforgeConfig: Declares a tool dependency on CurseForge.
TOOL - Enum constant in enum class io.github.smootheez.curseforge.RelationType: Indicates that the referenced project is a tool or utility associated with this project, typically not a runtime dependency.
toString() - Method in record class io.github.smootheez.curseforge.CurseforgeMetadata: Returns a string representation of this record class.
toString() - Method in record class io.github.smootheez.curseforge.GameVersionTag: Returns a string representation of this record class.
toString() - Method in record class io.github.smootheez.curseforge.Projects: Returns a string representation of this record class.
toString() - Method in record class io.github.smootheez.curseforge.ProjectsMetadata: Returns a string representation of this record class.
toString() - Method in record class io.github.smootheez.modrinth.DependencyMetadata: Returns a string representation of this record class.
toString() - Method in record class io.github.smootheez.modrinth.GameVersionTag: Returns a string representation of this record class.
toString() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns a string representation of this record class.

U

USER_AGENT - Static variable in class io.github.smootheez.Constants: The User-Agent header sent with HTTP requests made by the publisher.

V

VALID_RELEASE_TYPE - Static variable in class io.github.smootheez.Constants: Valid release channels supported for uploads (e.g., release, beta, alpha).
valueOf(String) - Static method in enum class io.github.smootheez.curseforge.ChangelogType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.smootheez.curseforge.EnvironmentType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.smootheez.curseforge.RelationType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.smootheez.LoaderType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.github.smootheez.modrinth.DependencyType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.github.smootheez.curseforge.ChangelogType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.smootheez.curseforge.EnvironmentType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.smootheez.curseforge.RelationType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.smootheez.LoaderType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.github.smootheez.modrinth.DependencyType: Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in record class io.github.smootheez.modrinth.GameVersionTag: Returns the value of the version record component.
versionNumber() - Method in record class io.github.smootheez.modrinth.ModrinthMetadata: Returns the value of the versionNumber record component.
versionType() - Method in record class io.github.smootheez.modrinth.GameVersionTag: Returns the value of the versionType record component.

A C D E F G H I L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form