CloudNet Documentation

To add CloudNet to a Gradle project, ensure mavenCentral() is included in your repositories. You can manage versions centrally using the CloudNet Bill of Materials (BOM) or specify versions directly for individual artifacts. For plugin/module development, the driver artifact is typically used with compileOnly scope.

repositories {
  // ensure maven central is added
  mavenCentral()
}

dependencies {
  // optional - you can also specify versions directly
  implementation platform('eu.cloudnetservice.cloudnet:bom:%version%')
  compileOnly 'eu.cloudnetservice.cloudnet:driver'

  // without bom
  compileOnly 'eu.cloudnetservice.cloudnet:driver:%version%'
}

To add CloudNet to a Maven project, you can use the bom artifact within <dependencyManagement> to align versions across all CloudNet submodules. The driver artifact should be added to your <dependencies> section, typically with a provided scope.

<!-- optional - you can also specify versions directly -->
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>eu.cloudnetservice.cloudnet</groupId>
      <artifactId>bom</artifactId>
      <version>%version%</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>eu.cloudnetservice.cloudnet</groupId>
    <artifactId>driver</artifactId>
    <version>%version%</version> <!-- only needed when bom is not used -->
    <scope>provided</scope>
  </dependency>
</dependencies>

To build CloudNet from the source code, you must have JDK 25 installed and an active internet connection.

1. Clone the repository.
2. Run the Gradle wrapper from the project root.

./gradlew

A CommandSource represents an object capable of receiving messages related to command execution and parsing. It acts as the entry point for commands, determining where command input originates and how permissions are validated for the sender.

Common implementations include the system console or network-based message receivers. If you need to interact with the system's primary console, you can retrieve its dedicated CommandSource instance via the static console() method.

// Accessing the system console command source
CommandSource console = CommandSource.console();

The CloudNetPlugin is used for CloudNet development to automate project configuration, including setting the project group to eu.cloudnetservice.cloudnet and the project version to the current CloudNet version. It also manages Javadoc indexing for offline documentation support.

// Apply the plugin in your build.gradle.kts
plugins {
    id("eu.cloudnetservice.cloudnet")
}

The CloudNetPluginsPlugin is the entry point for developing CloudNet plugins using Gradle. Applying this plugin automatically configures the project by applying the CloudNetJavaPlugin and registering source processing tasks. This simplifies the build lifecycle for CloudNet-compatible extensions.

plugins {
    id("eu.cloudnetservice.cloudnet.plugins") // Note: The exact plugin ID should be verified in the plugin marker artifact
}

The CloudNetUpdaterPlugin is a Gradle plugin designed to manage CloudNet update information across a project hierarchy.

• In Subprojects: It applies the CloudNetJavaPlugin and registers a configuration named updaterData. It also provides a prepareUpdaterData task that prepares data into the project's temporary directory.
• In the Root Project: It aggregates updater data from all subprojects into an updaterDependencies configuration and provides a genUpdaterInformation task to generate metadata.

To use this plugin, apply it to your Gradle project. If applied to a multi-module project, it should be applied to the root project to correctly aggregate information from subprojects.

The CloudNetModulesApiPlugin is a Gradle plugin used to configure the CloudNet Modules API within a project. Applying this plugin automatically applies the CloudNetJavaApiPlugin and registers the necessary processes for handling sources. This is a high-level entry point for projects intending to integrate with the CloudNet Modules API ecosystem.

// In your build.gradle.kts
plugins {
    id("eu.cloudnetservice.cloudnet.modules-api") // Note: The exact plugin ID should be verified in the plugin marker artifact or plugin portal
}

The CloudNetModulesPlugin is used to set up a Gradle project for developing CloudNet modules. When applied, it automatically configures several sub-plugins including CloudNetJavaPlugin, CloudNetUpdaterPlugin, and JuppiterPlugin. It also configures the testImplementation configuration to extend from the moduleLibrary configuration, ensuring module dependencies are available during testing.

plugins {
    id("eu.cloudnetservice.cloudnet.modules") // Assuming the plugin ID follows standard convention
}