From ae3d7842ba4f261add8d5beb207d613515ee6602 Mon Sep 17 00:00:00 2001
From: Myles <43725835+MylesAndMore@users.noreply.github.com>
Date: Tue, 13 Dec 2022 11:49:07 -0600
Subject: update versioning, config, and readme for pre-release

---
 README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8559810..909880e 100644
--- a/README.md
+++ b/README.md
@@ -20,4 +20,55 @@ If you've never heard of it, [Tumble](https://minecraft-archive.fandom.com/wiki/
 
 ## Setup
 
-...  
+1. Simply [download]() **add link to download** the plugin's JAR file and place it in your server's plugins directory.  
+
+    - *Note: Multiverse is also required for the plugin to run, you may download it [here](https://www.spigotmc.org/resources/multiverse-core.390/).*  
+
+2. Make sure that you have at least two worlds in your world directory! One is for your lobby world, and the other is for your game arena.  
+
+    - If you would like an experience similar to the original game, see [my guide]() **add this guide** for using the original worlds.  
+
+3. Start your server. The plugin will generate a couple of warnings, these are normal.
+4. Ensure that you have imported your worlds into Multiverse. This can be done with the command ```/mv import <your-world-name> normal```.
+5. Now you need to tell Tumble which world is your lobby and which world is your game arena. You can do this with  ```/tumble:link <your-lobby-world> lobby``` and ```/tumble:link <your-game-world> game``` respectively.
+6. You're done! You can now start games with the command ```/tumble:start```.
+
+Scroll down for more options to configure your game.  
+
+## Commands
+
+- ```/tumble:reload```
+
+  - *Description:* Reloads the plugin's configuration.
+  - *Usage:* ```/tumble:reload```
+  - *Permission:* ```tumble.reload```
+- ```/tumble:link```
+  - *Description:* Links a world on the server as a lobby or game world.
+  - *Usage:* ```/tumble:link <world> (lobby|game)```
+  - *Permission:* ```tumble.link```
+- ```/tumble:start```
+  - *Description:* Force starts a Tumble match (with an optional game type).
+  - *Usage:* ```/tumble:start [game-type]```
+  - *Permission:* ```tumble.start```
+- ```/tumble:winlocation```
+  - *Description:* Sets the location to teleport the winning player of a game. Uses the player's location if no arguments are specified.
+  - *Usage:* ```/tumble:winlocation [x] [y] [z]```
+  - *Permission:* ```tumble.winlocation```
+- ```/tumble:autostart```
+  - *Description:* Configures the auto start functions of Tumble.
+  - *Usage:* ```/tumble:autostart <playerAmount> [enable|disable]```
+  - *Permission:* ```tumble.autostart```
+
+## Configuration  
+
+- ```gameMode```  
+  - Customize the default game mode of Tumble.  
+  - Acceptable options include: shovels, snowballs, mixed  
+  - *Default:* ```mixed```  
+
+- ```hideJoinLeaveMessages```
+  - Hides join/leave messages in public chat.  
+  - *Default:* ```false```  
+
+- ```permissionMessage```
+  - Customize the message that displays when the player does not have permission to execute a command from this plugin.  
-- 
cgit v1.2.3