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.6.tar.gz (49.6 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.6-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for minecraft_install_manager-1.0.6.tar.gz
Algorithm Hash digest
SHA256 f782e7865f9b26c59872d79bf7986497d6d763ca9c56cda038e6fdade7d92d64
MD5 566b4837cde520407e5f587a0871c224
BLAKE2b-256 449a9f280b23583b7aa23fb7819bbf2044af28a741ae9781e07709a528f6f681

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for minecraft_install_manager-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a519a55b8f54951d35878dcbf2f17f3cafe8ee259cce4043bfab094220b0de31
MD5 6b4eaf4757f8d7c5a9715097b0d58411
BLAKE2b-256 128572c390eaf7ca27bb9b7434b1ba7b7ab2e6aff88ecc9c1712b1f12aea680d

See more details on using hashes here.

Provenance

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