Skip to content

MrSimpleJS/PlugManX

 
 

Repository files navigation

This is a PlugMan *Fork*

PlugMan

PlugMan is a simple, easy to use plugin that lets server admins manage plugins from either in-game or console without the need to restart the server.

Features

  • Enable, disable, restart, load, reload, and unload plugins from in-game or console.
  • List plugins alphabetically, with version if specified.
  • Get useful information on plugins such as commands, version, author(s), etc.
  • Show hard dependencies, soft dependencies, and plugins that depend on a target plugin.
  • Easily manage plugins without having to constantly restart your server.
  • List commands a plugin has registered.
  • Find the plugin a command is registered to.
  • Tab completion for command names and plugin names.
  • Dump plugin list with versions to a file.
  • Check if a plugin is up-to-date with dev.bukkit.org
  • Load and reload modern Paper plugins that use paper-plugin.yml.
  • Clean up Paper plugin manager state, commands, listeners, and provider storage on unload.
  • Reload/restart dependent plugins in a safer order and optionally limit dependent reloads.
  • Confirm dangerous bulk reload/restart operations before affecting many plugins.
  • Optional Paper reload diagnostics with paperReloadDebug.
  • Permissions Support - All commands default to OP.

Commands

Command Description
/plugman help Show help information.
/plugman list [-v] List plugins in alphabetical order. Use "-v" to include versions.
/plugman info [plugin] Displays information about a plugin.
/plugman dump Dump plugin names and version to a file.
/plugman usage [plugin] List commands that a plugin has registered.
/plugman deps [plugin] Show dependencies and dependent plugins for a plugin.
/plugman lookup [command] Find the plugin a command is registered to.
/plugman enable [plugin|all] Enable a plugin.
/plugman disable [plugin|all] Disable a plugin.
/plugman restart [plugin|all] Restart (disable/enable) a plugin.
/plugman load [plugin] Load a plugin.
/plugman reload [plugin|all] Reload (unload/load) a plugin.
/plugman reloadconfig Reload PlugMan config and messages.
/plugman reloadmode [mode] View or change dependent reload mode.
/plugman unload [plugin] Unload a plugin.
/plugman check [plugin|all] [-f] Check if a plugin is up-to-date.

Reload Modes

/plugman reloadmode controls which dependent plugins are reloaded together with the target plugin:

Mode Description
ALL Reload plugins with hard depend and softdepend links.
REQUIRED_ONLY Reload only plugins with a required depend link.
OFF Do not reload dependent plugins automatically.

Permissions

Permission Node Default Description
plugman.admin OP Allows use of all PlugMan commands.
plugman.update OP Allows user to see update messages.
plugman.help OP Allow use of the help command.
plugman.list OP Allow use of the list command.
plugman.info OP Allow use of the info command.
plugman.dump OP Allow use of the dump command.
plugman.usage OP Allow use of the usage command.
plugman.deps OP Allow use of the deps command.
plugman.lookup OP Allow use of the lookup command.
plugman.enable OP Allow use of the enable command.
plugman.enable.all OP Allow use of the enable all command.
plugman.disable OP Allow use of the disable command.
plugman.disable.all OP Allow use of the disable all command.
plugman.restart OP Allow use of the restart command.
plugman.restart.all OP Allow use of the restart all command.
plugman.load OP Allow use of the load command.
plugman.reload OP Allow use of the reload command.
plugman.reload.all OP Allow use of the reload all command.
plugman.reloadconfig OP Allow use of the reloadconfig command.
plugman.reloadmode OP Allow use of the reloadmode command.
plugman.unload OP Allow use of the unload command.
plugman.check OP Allow use of the check command.
plugman.check.all OP Allow use of the check command.

Configuration

File URL
config.yml https://github.com/Test-Account666/PlugManX/blob/master/plugman-core/src/main/resources/config.yml

Important options:

Option Default Description
ignored-plugins See config Plugins PlugManX should not manage.
paperReloadDebug false Enables extra Paper reload diagnostics in console.
reloadDependentsMode REQUIRED_ONLY Controls dependent reload behavior for reload/restart operations.

Building

Build Instructions

Building PlugManX is simple:

  1. Clone the repository:

    git clone https://github.com/Test-Account666/PlugManX.git
    cd PlugManX
  2. First Build

    mvn install -N
    cd plugman-paper
    mvn paper-nms:init
    cd ..
  3. Build the project:

    mvn clean install
  4. Find the built artifacts:

    • Individual module JARs will be in each module's target/ directory
    • The assembled distribution will be in plugman-assembly/target/

Version Management

PlugManX uses a centralized version property for easy version management across all modules. To update the version:

  1. Edit the <plugman.version> property in the root pom.xml file
  2. The version will automatically be updated in all modules and resource files during build

Current version is managed by the plugman.version property in the parent POM.

Developers

Maintenance instructions for adding messages, finding Paper API classes, and updating Paper reload compatibility are documented in DEVELOPMENT.md.

How to include PlugMan with Maven:

<repositories>
    <!-- PlugMan -->
    <repository>
        <id>PlugManX</id>
        <url>https://raw.githubusercontent.com/Test-Account666/PlugManX/repository/</url>
    </repository>
</repositories>

<dependencies>
<dependency>
    <groupId>com.rylinaux</groupId>
    <artifactId>PlugManX</artifactId>
    <version>${plugman.version}</version>
    <scope>provided</scope>
</dependency>
</dependencies>

How to include PlugMan with Gradle:

repositories {
    maven {
        name = 'PlugManX'
        url = 'https://raw.githubusercontent.com/Test-Account666/PlugManX/repository/'
    }
}
dependencies {
    compileOnly 'com.rylinaux:PlugManX:${plugman.version}'
}

License

This project is a fork of PlugMan (Link no longer works) and is distributed under the same license: LICENSE.

About

Plugin manager for Bukkit servers.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages