From 2159b2493792e7071832f669e0a495d2d7897a8c Mon Sep 17 00:00:00 2001 From: gekkedev <17025257+gekkedev@users.noreply.github.com> Date: Sat, 13 Jul 2019 18:35:18 +0200 Subject: [PATCH] wrote initial readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9a1dde2..000f3c6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# skyblock -SkyBlock plugin for Spigot-based Minecraft servers +# SkyBlock +Minimalist SkyBlock plugin for Spigot-based Minecraft servers + +## Installation +1. Download [this JAR file](https://github.com/gekkedev/skyblock/releases/latest) or compile it by yourself. +2. Place the file in your server's plugins directory (using `/reload` is not recommendable). + +## Usage +Enter `/skyblock` or just `/sb` to start playing SkyBlock and `/spawn` (an additional plugin is required for this). +In case you ever mess up, you can reset your island by entering `/skyblock reset` or just `/sb reset` and the SkyBlock island will be recreated. + +## Compatibility +The plugin is intended to run on Spigot 1.13.2 or higher.