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

JSON 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

MinecraftPluginManager is configured to search for plugins from

MinecraftPluginManager 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.1.tar.gz (48.3 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.1-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for minecraft_install_manager-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1f26d6fb9e7eeb8ad5d2c0bb08c7414bf7e21a32c3820feeaff89663f40b3442
MD5 27acc0793e9f68d5d97912df81b5299d
BLAKE2b-256 13ff38697e2dc01c896172a8097b4b8ed6e8380f65661bfc432d91c0a93a34b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraft_install_manager-1.0.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for minecraft_install_manager-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d41c2217bdef299b38f4326fc2ca84b7d9d869526254cfbeb547dd19ddf77195
MD5 8a0c1cad01d734cf01f03e40fd49e0b1
BLAKE2b-256 987449f9043a975daec5b3c9af60e30ebe719914b9c1d0aeba3a5703587b1a3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecraft_install_manager-1.0.1-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