Skip to main content

A small CLI to find and download Minecraft server plugins from multiple repositories

Project description

MinecraftPluginManager

Python CI

Python utility to query, download, and install Minecraft servers and plugins

Features

  • Search for server versions across multiple server repositories (e.g. PaperMC, Fabric, or Vanilla)
  • Download Minecraft server files
  • Search for plugins across multiple plugin repositories
    • Filter searches by server version compatibility
  • List available plugin versions
  • Download plugin files
  • Define a server configuration with a JSON file. Use mim to install or update the configuration
    • Define the server type and version or range of versions
    • Define the required plugins. mim will install only compatible servers and plugins
    • mim will discover existing server and plugin files and clean up old versions upon install

Installation

pip install thehappykraken/minecraft-install-manager

Usage

Use mim --help to view the help documentation

YAML Format

# loader - The name of the plugin loader such as paper, fabric, or vanilla
loader: "plugin loader"

# server - The plugin loader version such as 1.20.1
# x may be used to indicate a don't care value. e.g. 1.x.x or 1.20.x
server: "1.x.x"

# plugins - A list of plugins
plugins:
    # name - The name of the plugin. For Modrinth, this must match the plugin name in Modrinth
    # version - The plugin version. If omitted, the highest version which meets compatibility
    #           requirements will be used. If included, compatibility requirements are evaluated
    #           but not enforced
    # id - Repository ID to identify the plugin.
    #      For Spiget, this is the resource ID. e.g. 101066
    #      For GitHub, this is the repository name. e.g. MyOwner/MyRepository
    # assets - A list of asset files to include in the install
    #          If omitted, all assets are downloaded
    #          Accepts regex inputs
  - name: MyPlugin
    #
    version: "1.2.3"
    id: "Plugin ID"
    assets:
      - "pluginfile-A-.*.jar"
      - "pluginfile-B-.*.jar"

Repositories

MinecraftInstallManager is configured to search for plugins from

MinecraftInstallManager is configured to search for servers from

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

minecraft_install_manager-1.0.7.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

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

minecraft_install_manager-1.0.7-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

Details for the file minecraft_install_manager-1.0.7.tar.gz.

File metadata

File hashes

Hashes for minecraft_install_manager-1.0.7.tar.gz
Algorithm Hash digest
SHA256 4e3aa792c18eea121bb6262573eccc5756d41fe87cc781b8b2e74d91d6eb0dc4
MD5 008a49234b894a0f1712dbeae532f97e
BLAKE2b-256 efe16b9e447060f6fac32925258ebbfbdf42aa82e85e5c581448fcac24f820cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraft_install_manager-1.0.7.tar.gz:

Publisher: python-publish.yml on thehappykraken/MinecraftInstallManager

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file minecraft_install_manager-1.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for minecraft_install_manager-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1126e50d44545f48866461a479ab75818fc79586510b1ff8140ddb99f2e103c7
MD5 7b5afe8ce98d2bbab3e6b53c45ac89b8
BLAKE2b-256 8bc7ef0d1efc0f6bc77dbab9700aa60970e5c8bd34fc9154e422a55ce2fd258c

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraft_install_manager-1.0.7-py3-none-any.whl:

Publisher: python-publish.yml on thehappykraken/MinecraftInstallManager

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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