From 6b46e134a237928171fc735b60f8763b049b7b0e Mon Sep 17 00:00:00 2001 From: Neocky Date: Wed, 10 Mar 2021 15:00:24 +0100 Subject: [PATCH] Edited about & added need help --- README.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b303c00..9d6693d 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,34 @@ # pluGET -A plugin manager that handles [Spigot plugins](https://www.spigotmc.org/resources/) for minecraft servers written in python. +A plugin manager that handles [Spigot plugins](https://www.spigotmc.org/resources/) for minecraft servers written in python. + ## Issues? Found a bug? -[Create an issue.](https://github.com/Neocky/pluGET/issues/new/choose) +[Create an issue.](https://github.com/Neocky/pluGET/issues/new/choose) + ## About -This is a plugin manager for minecraft [Spigot](https://www.spigotmc.org/) servers and its forks (e.g. [PaperMC](https://papermc.io/)). -It uses the [Spiget](https://spiget.org/) API to download and compare plugin versions. -It can download the latest version of plugins. +This is a package/plugin manager for minecraft [Spigot](https://www.spigotmc.org/) servers and its forks (e.g. [PaperMC](https://papermc.io/)). +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 are pretty self explanatory so every server owner and not only the most tech savy ones can use pluGET to ease their plugin handling. +Follow the [Installation](https://github.com/Neocky/pluGET#installation) below for an easy and hassle free setup of pluGET. +If you still have questions [here](https://github.com/Neocky/pluGET#need-help) is the best place to ask for support. + +The program works with a locally installed server or with a remote host through SFTP, when configured in the config. +It uses the [Spiget](https://spiget.org/) API to download and compare plugin versions and can download the latest version of plugins from the [Spigot](https://www.spigotmc.org/) site. +So what can it do exactly? +pluGET can: +- work locally or through sftp +- 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 + + +## Need help? +[Discord](https://discord.gg/tTrYuaVXxN) + ## Installation ### Python @@ -32,18 +51,21 @@ Python needs to be installed on your machine. Get it [here](https://www.python.org/downloads/). ### Dependencies Install the needed packages for this project. -Execute this command in the ```/plugGET``` folder: +Execute this command in the ```\plugGET``` folder: ```python pip install -r requirements.txt ``` + ### Edit the Config When run the first time, the config will be created in the root package folder and the program will close. -Edit the config to your needs and rerun it. +Edit the config to your needs and relaunch pluGET. **Now you are good to go!** + ## Usage -The following are examples for the general usage: +Execute the launcher.bat in the ```\pluGET``` folder. This will launch pluGET correctly. +The following are examples of input for the general usage: (Hint: 'all' can always be exchanged through the plugin name or the plugin id and reverse) #### Download the latest update of a specific package: ```