TabooLib

https://github.com/taboolib/docs
Admin
This repository contains documentation for TabooLib, a framework for building Minecraft plugins,...
Tokens:2,200
Snippets:20
Trust Score:7.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installing TabooLib Modules with Dependencies in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Shows how to install multiple modules that have dependencies on each other. When installing `module-ai`, its dependency `module-nms` must also be installed.

```kotlin
taboolib {
    // Install ai module and its dependent nms module
    install("module-ai", "module-nms")
}
```

--------------------------------

### Installing Specific TabooLib Modules in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Demonstrates how to install individual TabooLib modules using the `install` function within the `taboolib` block. Modules like `common` and platform implementations like `platform-bukkit` need to be explicitly installed to be available.

```kotlin
taboolib {
    // Install common module
    install("common")
    // Install Bukkit platform implementation
    install("platform-bukkit")
}
```

--------------------------------

### Configuring Plugin Load Phase in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Specifies when the plugin should be loaded by the server platform. Common phases include `START` (server startup) and `POSTWORLD` (after the first world loads), effective on Bukkit and Nukkit platforms.

```kotlin
taboolib {
    description {
        // START means this plugin starts loading when the server starts.
        // POSTWORLD means this plugin starts loading after the first world is loaded.
        load("START")
    }
}
```

--------------------------------

### Configuring General TabooLib Settings in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

The main configuration block for TabooLib settings in `build.gradle.kts`. It allows installing modules, setting build classifiers, and specifying the required TabooLib version.

```kotlin
taboolib {
    // Currently installed modules
    install("common")
    install("module-nms", "module-nms-util")
    install("platform-bukkit")
    classifier = null
    // Current TabooLib version
    version = "6.0.X-X"
}
```

--------------------------------

### Setting TabooLib Compile Options in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Applies various options that modify TabooLib's compilation logic. Examples include controlling the retention of Kotlin module files or skipping certain build steps like dependency loading or relocation.

```kotlin
taboolib {
    options("keep-kotlin-module")
}
```

--------------------------------

### Initializing Docusaurus Project with CLI (Shell)

Source: https://github.com/taboolib/docs/blob/master/README.md

This shell command uses the `npx` tool to execute the `create-docusaurus` CLI. It initializes a new Docusaurus project named `my-website` using the `classic` template. This is the standard way to scaffold a Docusaurus site locally.

```shell
npx create-docusaurus@latest my-website classic
```

--------------------------------

### Configuring Basic Project Information in Gradle Properties

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Defines fundamental project details like the group ID (package name) and version in the `gradle.properties` file. TabooLib uses the group ID for internal redirection.

```properties
# Package name (TabooLib will redirect to com.github.username.taboolib)
group=com.github.username
# Version
version=1.0.0
```

--------------------------------

### Setting Plugin Description in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Configures the main description for the plugin within the `description` block under `taboolib`. This description helps users understand the plugin's purpose.

```kotlin
taboolib {
    description {
        desc("I am the plugin's description")
    }
}
```

--------------------------------

### Configuring Multiple Plugin Dependencies with Combined Options in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Illustrates configuring multiple plugin dependencies simultaneously, combining various options like platform restriction, version, load order, and optional status for different dependencies.

```kotlin
taboolib {
    description {
        dependencies {
            name("Adyeshach").optional(true)
            name("Chemdah").with("bukkit").optional(true)
            name("spongeapi").version("7.2.0").with("sponge7")
            name("spongeapi").version("8.0.0").with("sponge8").loadafter(true)
            name("ic3").with("sponge7").mod(true)
        }
    }
}
```

--------------------------------

### Setting Plugin Links in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Defines various relevant links for the plugin, such as homepage, source code repository, and issue tracker, within the `links` block under `description`. Only the homepage link is retained on non-Sponge8 platforms.

```kotlin
taboolib {
    description {
        links {
            // Only homepage link is kept on non-Sponge8 platforms
            name("homepage").url("https://tabooproject.org")
            name("source").url("https://github.com/taboolib/taboolib")
            name("issues").url("https://github.com/taboolib/taboolib/issues")
        }
    }
}
```

--------------------------------

### Relocating Kotlinx Serialization with TabooLib (Gradle)

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/dependencies/library-for-kotlin.md

This Gradle configuration snippet demonstrates how to relocate the `kotlinx.serialization` package. This is a mandatory prerequisite when using Kotlinx Serialization within a TabooLib project to prevent class conflicts.

```Groovy
taboolib {
    relocate("kotlinx.serialization", "kotlinx.serialization133")
}
```

--------------------------------

### Defining Plugin Dependencies in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Lists required plugin dependencies within the `dependencies` block under `description`. Various options allow specifying dependency names, target platforms, versions, load order, optional status, and whether it's a mod dependency.

```kotlin
taboolib {
    description {
        dependencies {
            // Dependent plugin name (do not mistake this for self, it will trigger a self-loop error)
            name("Kotlin")
            // Restrict platform (this dependency will be removed on other platforms)
            name("Kotlin").with("bukkit")
            // Version (effective only on Sponge7/8 platforms)
            name("Kotlin").version("1.0.0")
            // Load after this plugin (effective only on Sponge8 platform)
            name("Kotlin").loadafter(true)
            // Load before this plugin (effective only on Bukkit, Nukkit platforms)
            name("Kotlin").loadbefore(true)
            // Soft dependency (effective only on Bukkit, Nukkit, Bungee, Sponge8 platforms)
            name("Kotlin").optional(true)
            // Mod dependency (effective only on Sponge7 platform)
            name("Kotlin").mod(true)
        }
    }
}
```

--------------------------------

### Configuring Plugin Author in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Specifies the author's name and an optional description within the `description` block. The author description is currently effective only on the Sponge platform.

```kotlin
taboolib {
    description {
        // Author name
        name("Bad Black")
        // Author description (effective only on Sponge platform)
        name("Bad Black").description("TabooLib Devoloper")
    }
}
```

--------------------------------

### Adding Kotlinx Serialization Dependencies (Referencing) (Gradle)

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/dependencies/library-for-kotlin.md

This Gradle snippet illustrates how to add Kotlinx Serialization as a `compileOnly` dependency. This method avoids including the library directly in the JAR; instead, it will be downloaded dynamically by TabooLib from a repository (like Aliyun Central) at server startup.

```Groovy
dependencies {
    compileOnly("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.3")
}
```

--------------------------------

### Defining Required API Versions in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Sets the target API versions the plugin is built against for platforms like Bukkit and Nukkit. These settings are often automatically inferred but can be explicitly defined here.

```kotlin
taboolib {
    description {
        // These are present by default; they can be omitted if unchanged.
        bukkitApi("1.13")
        nukkitApi("1.0.0")
    }
}
```

--------------------------------

### Setting Plugin Prefix in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Configures the plugin prefix, typically used by platform consoles for logging messages originating from the plugin. This setting is primarily effective on Bukkit and Nukkit platforms.

```kotlin
taboolib {
    description {
        prefix("TabooLib")
    }
}
```

--------------------------------

### Declaring Kotlinx Serialization Runtime Dependencies (Kotlin)

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/dependencies/library-for-kotlin.md

This Kotlin snippet demonstrates how to declare the required runtime dependencies for Kotlinx Serialization using the `@RuntimeDependencies` annotation. This is necessary when using the 'referencing' dependency method to instruct TabooLib to load the dependencies dynamically, including specifying relocation paths based on the Kotlin version.

```Kotlin
@RuntimeDependencies(
    RuntimeDependency(
        "!org.jetbrains.kotlinx:kotlinx-serialization-core-jvm:1.3.3",
        test = "!kotlinx.serialization.Serializer",
        relocate = ["!kotlin.", "!kotlin1822.", "!kotlinx.serialization.", "!kotlinx.serialization133."],
        transitive = false
    ),
    RuntimeDependency(
        "!org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:1.3.3",
        test = "!kotlinx.serialization.json.Json",
        relocate = ["!kotlin.", "!kotlin1822.", "!kotlinx.serialization.", "!kotlinx.serialization133."],
        transitive = false
    )
)
class RuntimeEnv
```

--------------------------------

### Adding Kotlinx Serialization Dependencies (Packed) (Gradle)

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/dependencies/library-for-kotlin.md

This Gradle snippet shows how to add Kotlinx Serialization as packed dependencies using the `taboo()` dependency helper. This method includes the library directly in the plugin JAR, making it simpler but resulting in a larger file size. Transitive dependencies are disabled.

```Groovy
dependencies {
    taboo("org.jetbrains.kotlinx:kotlinx-serialization-core-jvm:1.3.3") { isTransitive = false }
    taboo("org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:1.3.3") { isTransitive = false }
}
```

--------------------------------

### Configuring Package Relocation in Build Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Sets up package relocation rules to prevent dependency conflicts. It allows replacing one package name prefix with another across the compiled code.

```kotlin
taboolib {
    relocate("com.google", "my.project.library.google")
}
```

--------------------------------

### Setting Project Name in Settings Gradle KTS

Source: https://github.com/taboolib/docs/blob/master/docs/plugin/configuration/settings-6-0.md

Sets the root project name in the `settings.gradle.kts` file. This name is used by Gradle to identify your project.

```kotlin
// Project name
rootProject.name = "ExampleProject"
```
Tokens:
Raw