Skip to main content

A command-line package manager for Minecraft server plugins.

Project description

MSPM: Minecraft Package Manager

MSPM is a command-line utility designed to automate the resolution, installation, and management of Minecraft server plugins. It retrieves packages from multiple popular upstream repositories, verifies software compatibility constraints, and downloads updates directly to the target environment.

Features

  • Resolution across multiple platforms: Modrinth, Hangar, SpigotMC, and Bukkit.
  • Support for direct URLs and GitHub releases.
  • Automated compatibility verification based on server platform and target Minecraft version.
  • Concurrency control for browser-based download flows requiring Cloudflare verification.
  • Structured lockfiles (mspm.toml.lock) ensuring repeatable environments.

Installation

To install the package directly from PyPI, run:

pip install mspm
pip install selenium webdriver-manager

Configuration

When run for the first time, MSPM generates a template configuration file named mspm.toml in your working directory. You can edit this file to match your server environment:

[server]
version = "1.20.4"
platform = "PAPER"
plugins_dir = "./plugins"
jar_name = "server.jar"

[dependencies]
# Your managed plugins will be added here

Command Usage

Search for Plugins

To search for a plugin across all indexed upstream repositories:

mspm search EssentialsX

Add a Plugin

To register and download a plugin, add it by name:

mspm add EssentialsX

To specify a target source or version manually:

mspm add Vault --source modrinth --version 1.7.3

Install Configured Dependencies

To install all plugins registered inside mspm.toml that are missing or require installation:

mspm install

Update Managed Plugins

To query upstreams for new releases matching your server version and update existing files:

mspm update

Remove Plugins

To delete a plugin and its tracked files from both configuration and server directory:

mspm remove EssentialsX

General Arguments

  • --yes, -y: Bypass confirmation prompts.
  • --allow-untested: Force installation of components marked as incompatible.
  • --debug: Run with verbose diagnostic output.

License

This software is released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mspm-2.0.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mspm-2.0.0-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file mspm-2.0.0.tar.gz.

File metadata

  • Download URL: mspm-2.0.0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.14 Linux/7.1.3-zen2

File hashes

Hashes for mspm-2.0.0.tar.gz
Algorithm Hash digest
SHA256 8ab742c248b53285198fc668c47eab07051b63915fd65044c803b8fe727e4f81
MD5 8656518d82926f031ba151f4f1763c5b
BLAKE2b-256 cab28024496276cbf68409a9a0ec5c52a3d9fbd6b0fbeb85c9e20e627ef4342c

See more details on using hashes here.

File details

Details for the file mspm-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: mspm-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.14 Linux/7.1.3-zen2

File hashes

Hashes for mspm-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 edbe2cfd75e8f1fbf9630a6f96a340bc55f726d7dc18c422b2147b5c12482d56
MD5 671054b545700c0dad458fbca1fd1423
BLAKE2b-256 19042c5d927987464c297bfaf6c0bf9ebbd41f709821ae8cac612be3783dee73

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page