Skip to main content

A Minecraft Spigot plugin manager that adheres to the Unix philosophy and Python best practices

Project description

Spud

spudman logo

GPLv3 License GitHub Release PyPI downloads Code style: Black

A cross-platform, Spigot plugin manager that adheres to the Unix philosophy and Python best practices.

Some focuses of the project are:

  1. Easy and simple commands (updating all your plugins is as simple as spud update)

  2. Unlike other options like pluGET, it adheres to Unix conventions and doesn't force you to use a GUI, making it easy to use in scripts.

  3. Insisting upon readability, static type hinting, test-driven development, and consistent styling in the codebase.

  4. Descriptive output and actionable error messages

Installation

Python 3.8 or later is required

Install with python -m pip install spud-mc

Run spud -h to see all the options.

Example usages

  • Install a plugin: spud install PluginName

  • Install a plugin without prompting for input: spud -n install PluginName

  • Update all plugins in the working directory: spud update

  • Update all plugins in ~/server/plugins: spud -d ~/server/plugins update

  • Update plugin myplugin.jar: spud update myplugin.jar

Known Issues

  • Some resources have lots of filler in the title. e.g. [1.8-1.17] · PluginName | 😃 😃 😃 | Epic Gaming Moments. Spud tries its best to extract the plugin name, but it will fail if there is copious amounts of garbage in the title

  • Spud can't update plugins it has not installed. Make sure to install the plugin with Spud first, so it can save a metadata file to the jar.

  • Spud can't install resources not listed on https://spigotmc.org

  • Spud can't install premium resources

Acknowledgements

Logo created by zach_can_draw

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

spud-mc-1.3.0.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

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

spud_mc-1.3.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file spud-mc-1.3.0.tar.gz.

File metadata

  • Download URL: spud-mc-1.3.0.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for spud-mc-1.3.0.tar.gz
Algorithm Hash digest
SHA256 bf1e3700b4cff0dedcf1a49386575054bc1af919f344732a499909a0c9ef8a16
MD5 72aa5af3022073ea7662ad5024da51f8
BLAKE2b-256 3ae76bf1f84bd61bddb026651ef6947d86e2fea7a2d3eb80acb58fcbb8fc789c

See more details on using hashes here.

File details

Details for the file spud_mc-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: spud_mc-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for spud_mc-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 078a51dfe5bec308ba47e2a4522d1a055aa34629b3edec885a25f563619df5be
MD5 04960f1234e99ddf55aabfab60cf1f0e
BLAKE2b-256 546dc2278ce6530f1cb28ec34189637ad8c026782e9af4fe1b4e7b6945e063d7

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