pluGET/README.md

pluGET

A powerfull package manager which handles Plugins and Server Software for minecraft servers.

Issues? Found a bug?

Create an issue.

About

This is a package manager for minecraft Spigot servers and its forks (e.g. PaperMC).
This is a standalone program written in python.
The program works with a locally installed server or with a remote host through SFTP, when configured in the config.
It uses the Spiget API to download and compare plugin versions and can download the latest version of plugins from the Spigot site.
It can also compare and download the latest update of specifif server software (e.g. PaperMC).

Plugin management was the hard part of mangaging a minecraft server. The time it took to check the Spigot ressource page for updates for the installed plugins and updating all plugins manually which have available updates was too long and shocking.
So I built pluGET to automate and ease the plugin handling of a minecraft server and to turn the most time consuming part of managing a minecraft server to an easy one.

This program is suited for minecraft server owners who want to save time and stay on top of their plugin versions.
The program input and the associated config file are pretty simple so every server owner and not only the most tech savy ones can use pluGET to ease their plugin handling.

Follow the Installation guide below for an easy and hassle free setup of pluGET.
Read Usage below to get some example inputs when using pluGET.
If you still have questions here is the best place to ask for support.

So what can it do exactly?
pluGET can:

• work locally or through sftp
• manage plugins:
  • download the latest version of a plugin
  • update every installed/one specific plugin
  • check for an update of every installed/one specific plugin
  • remove a plugin from the plugin folder
• manager server software:
  • download a specific server software version
  • check instlalled server software for update
  • update installed server software to a specific version
  • supported server software: PaperMc

There are more features in the work. Check Projects for a complete list.

So why do it manually when you can use pluGET to automate it? 🚀
Get the latest release here.

Donations

If you feel like showing your love and/or appreciation for this project then how about buying me a coffee! :)

Need help?

Installation

Python

Python needs to be installed on your machine.
Get it here.

Dependencies

Install the needed packages for this project.
Execute this command in the \plugGET folder:

pip install -r requirements.txt

Edit the Config

When run the first time, the config.ini file will be created in the root package folder and the program will close.
Edit the config to your needs and relaunch pluGET.
Now you are good to go!

Usage

As always, if you update plugins, shut down your server!

Execute the launcher.bat in the \pluGET folder. This will launch pluGET correctly.
Another way is to launch the src\__main__.py file.
The following are examples of input for the general usage:
(Hint: [thingsInBrackets] are optional & 'all' can always be exchanged through the plugin name or the plugin id and reverse)

Manage Plugins

Download the latest update of a specific package:

get [pluginID/pluginName]

get 'pluginID'

or:

get 'pluginName'

Check all plugins/one specific plugin for updates:

check [all/pluginName]

check all

or:

check 'pluginName'

Update all plugins/one specific plugin:

update [all/pluginName]

update all

or:

update 'pluginName'

Remove a plugin with the ID/Name:

remove [pluginID/pluginName]

remove 'pluginID'

or:

remove 'pluginName'

Search for a plugin:

search [pluginName]

search 'pluginName'

Exit program:

exit [anything]

exit .

Get link to here:

help [anything]

help .

Manage Server Software

Check installed server software for updates:

check serverjar

check serverjar

Update installed server software to latest/specific version:

update serverjar [Version]

update serverjar 'PaperMCVersion'

Download specific paper version:

get-paper [paperBuild] [minecraftVersion]

get-paper 550 1.16.5

or:

get-paper 321

Known problems

Can't get installed version

For example:

pluGET >> check all
Checking: all
Index | Name                           | Installed V. | Latest V. |  Update available
 [1]    Vault                            N/A            1.7.3        False

This is a known issue because the filename in the \plugin folder doesn't include a version.
This is the plugin file in the \plugin folder right now: Vault.jar
How it should be: Vault-1.7.3.jar
Many plugins which get download from Spigot won't have a file version in the name.

How to solve:

Delete the Vault.jar file and download the newest version with the get command:

pluGET >> get vault
Index | Name                        | Description                                                                                                          |  Downloads
 [1]    Vault                         Vault is a Permissions, Chat, & Economy API to give plugins easy hooks into these systems.                              989046
Select your wanted Ressource (Index)(0 to exit): 1
Downloadsize: 267.31 KB
File downloaded here: C:\Users\USER\Desktop\plugins\Vault-1.7.3.jar

Now you got the plugin with the correct name inside your \plugin folder: Vault-1.7.3.jar

And pluGET will tell you the installed version and check if an update is available when checking again:

pluGET >> check all
Checking: all
Index | Name                           | Installed V. | Latest V. |  Update available
 [1]    Vault                            1.7.3          1.7.3        False