https://github.com/austin-bowen/mcdl

A simple program for downloading Minecraft server software, such as (Craft)Bukkit and Spigot.
https://github.com/austin-bowen/mcdl

bukkit bungeecord cauldron craftbukkit genisys hexacord mcpc minecraft minecraft-servers nukkit paperspigot spigot tacospigot thermos waterfall

Last synced: 3 months ago
JSON representation

A simple program for downloading Minecraft server software, such as (Craft)Bukkit and Spigot.

• Host: GitHub
• URL: https://github.com/austin-bowen/mcdl
• Owner: austin-bowen
• License: mit
• Archived: true
• Created: 2017-05-01T07:56:09.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-07-25T20:56:08.000Z (over 1 year ago)
• Last Synced: 2024-10-16T13:04:32.676Z (4 months ago)
• Topics: bukkit, bungeecord, cauldron, craftbukkit, genisys, hexacord, mcpc, minecraft, minecraft-servers, nukkit, paperspigot, spigot, tacospigot, thermos, waterfall
• Language: Python
• Homepage:
• Size: 49.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
mcdl - Minecraft Downloader

===========================

    WARNING: Yive has removed the API from `Yive's Mirror `_, effectively rendering

    mcdl useless from now on... :'(  However, Minecraft software can still be downloaded from the site directly.

    I will keep this GIT repository up, in the hopes that he re-establishes the API.

A simple program for downloading pre-built Minecraft software, such as CraftBukkit and Spigot.

You can use mcdl to quickly download the latest .jar file for your

favorite Minecraft server, grab a specific server API version for plugin

development, etc. mcdl uses `Yive's Mirror `_

(no affiliation) to download pre-built Minecraft software for projects such as:

* `Bukkit / CraftBukkit `_

* `BungeeCord `_

* `Spigot `_

* `Thermos `_

* `Torch `_

* `Waterfall `_

* ... and many more!

Usage

-----

::

    mcdl get    [dest]  Download the project file

    mcdl list                 List the project files

Examples

--------

Find and download a specific version of CraftBukkit

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    $ mcdl list craftbukkit

      Craftbukkit Files                     |  MC Ver      |  Size

    ----------------------------------------+--------------+------------

      craftbukkit-latest.jar                |  Latest      |  20.78MB

      craftbukkit-0.0.1-SNAPSHOT.1000.jar   |  1.7.3 Beta  |  8.11MB

      craftbukkit-0.0.1-SNAPSHOT.1060.jar   |  1.7.3 Beta  |  8.14MB

      ...

      craftbukkit-1.11-R0.1-SNAPSHOT.jar    |  1.11        |  19.05MB

      craftbukkit-1.11.2-R0.1-SNAPSHOT.jar  |  1.11.2      |  20.79MB

      craftbukkit.src.zip                   |  Unknown     |  880.63kB

    $ mcdl get craftbukkit craftbukkit-1.11.2-R0.1-SNAPSHOT.jar

    Downloading CraftBukkit file "craftbukkit-1.11.2-R0.1-SNAPSHOT.jar"...

      |████████████████████████████████| 100% of 20.79MB (ETA 0:00:00)

    Saving to file "./craftbukkit-1.11.2-R0.1-SNAPSHOT.jar"...  Done.

    $ ls

    craftbukkit-1.11.2-R0.1-SNAPSHOT.jar

Download a Spigot build to a specific path

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::

    $ mcdl get spigot spigot-latest.jar /path/to/server/spigot.jar

    Downloading Spigot file "spigot-latest.jar"...

      |████████████████████████████████| 100% of 23.40MB (ETA 0:00:00)

    Saving to file "/path/to/server/spigot.jar"...  Done.

    $ ls /path/to/server/

    spigot.jar

Some time later (perhaps run by a cron job)...

::

    $ mcdl get spigot spigot-latest.jar /path/to/server/spigot.jar

    File "/path/to/server/spigot.jar" is already up-to-date

Installation (Linux)

--------------------

If you have `Python3 `_ installed, then you

can use pip to install mcdl to your system:

::

    $ sudo pip3 install mcdl

To uninstall mcdl:

::

    $ sudo pip3 uninstall mcdl

To upgrade mcdl to the latest version:

::

    $ sudo pip3 install --upgrade mcdl

Use Case: Automatic Server Updates (Linux)

------------------------------------------

You can use cron to automatically run mcdl to download the latest

server file. Here is a bare-bones example procedure for setting up a cron job

to automatically download the latest CraftBukkit .jar file every week:

::

    $ cd /etc/cron.weekly/

    $ sudo touch upgrade-craftbukkit       # Create file

    $ sudo chmod +x upgrade-craftbukkit    # Make it executable

Now edit the upgrade-craftbukkit file as superuser with your favorite text editor and write something like this:

::

    #!/bin/sh

    

    # Downloads the latest CraftBukkit .jar file

    

    mcdl get craftbukkit craftbukkit-latest.jar /path/to/server/craftbukkit.jar

    

    # File downloaded?

    if [ $? -eq 0 ]; then

        # Optionally, some command here to restart your Minecraft server

        # ...

    fi

cron will now run the upgrade-craftbukkit file every week, downloading

the latest CraftBukkit .jar file into your server's directory.