DOCSEARCHbyAlgolia
Submit Docs

TeamKUNPluginManager (KPM)

website·Indexed 31 days ago

https://kpm.kunlab.org/

A plugin manager for servers that supports installing, upgrading, and uninstalling plugins, including integration with GitHub. The documentation covers KPM v2 and v3, featuring a plugin resolver, dependency tree management, and a hook system for plugin operations. Includes Javadoc for v3.0.0-pre8.

Tokens
14.3K
Snippets
79
Records
147
Agent score
50%

What's inside KPM

  1. Overview of the KPM API

    The KPM API is a Java-callable API designed for developers to create plugins that integrate with KPM. To utilize all features of the KPM API, developers must first create a KPM information file (kpm.yml).

  2. Overview of the KPM Hook system

    The KPM Hook system allows the execution of arbitrary code during plugin operations (e.g., installation, upgrade, uninstallation). To use this system, an implementation that receives KPM Hooks must be bundled within the plugin's JAR file. Hooks with a Pre suffix are called before the operation, and those with a Post suffix are called after the operation.

  3. Overview of KPM Plugin Resolvers

    Plugin Resolvers are modules in KPM v3 that resolve a query string into a direct download link for a plugin. This eliminates the need to manually search for and copy direct links during installation. KPM attempts to resolve queries using registered resolvers in a specific order, supporting services like GitHub, SpigotMC, CurseForge, and Bukkit.

  4. Overview of KPM Developer Portal

    The KPM Developer Portal provides documentation and API information for developers creating plugins that integrate with KPM. It serves as the central hub for accessing the KPM API, plugin development best practices, and instructions for preparing GitHub repositories for easy installation via KPM.

  5. Overview of TeamKUNPluginManager (KPM)

    TeamKUNPluginManager (KPM) is a fully managed integrated plugin manager designed to simplify and secure the installation of plugins. It integrates into existing server management flows to automatically resolve dependencies registered on HTTP servers or remote repositories like GitHub. KPM builds an automated dependency tree and provides recommendations to remove unnecessary plugins, helping optimize server application performance and management. Its console user interface is inspired by tools such as apt, npm, and the Bukkit Plugin Installer.

  6. Overview of TeamKUNPluginManager (KPM)

    v2
    TeamKUNPluginManager (KPM) is a fully managed integrated plugin manager designed to simplify and secure the installation of plugins. It integrates into existing server management flows to automatically resolve dependencies registered on HTTP servers or remote repositories such as GitHub. KPM builds automated dependency trees and provides recommendations to identify unnecessary plugins, helping administrators optimize server application performance and maintain a secure environment. Its console user interface is inspired by package managers like apt, npm, and the Bukkit Plugin Installer.

  8. Understand the KPM v3 Installer framework

    The Installer in KPM v3 is a conceptual framework used to safely and completely modify plugins running on a server. Rather than simple file copying, plugin changes are handled by specific Installer implementations. This system ensures that plugin modifications are managed consistently across the server environment.

  9. KPM Plugin Management Command Overview

    KPM provides several subcommands for managing plugins. Most are accessed via /kpm <subcommand>:

    • install: Install a new plugin.
    • uninstall: Remove a plugin from the server.
    • info: Display detailed plugin information.
    • register: Link KPM with GitHub.
    • version: Check plugin versions (replaces the deprecated status command).

  10. Understand KPM system requirements and dependencies

    v2
    KPM (TeamKUNPluginManager) is a plugin manager that operates exclusively on PaperMC (a Minecraft server implementation). To use KPM, a GitHub account is required as it allows the installation of plugins hosted on GitHub.

  11. Retrieve detailed plugin information using /kpm info

    The /kpm info command displays comprehensive details about a specified plugin. The output includes basic plugin information, KPM-specific metadata (such as installation date and installer), a list of dependencies and dependents, file details (including modification dates and hashes), and any additional information provided by a KPM info file if present.
    /kpm info <plugin_name>

  12. Understand KPM and PaperMC compatibility

    KPM is the abbreviation for TeamKUNPluginManager. It is designed to operate exclusively on PaperMC, a Minecraft server implementation based on Spigot and Bukkit.