From 23429bbd3fe7e35ab9877e536f9ff9a2e71a9afc Mon Sep 17 00:00:00 2001
From: Myles <43725835+MylesAndMore@users.noreply.github.com>
Date: Mon, 12 Dec 2022 19:21:09 +0000
Subject: refactoring to prep for release!!

- refactor a bit of code
- add a bit more documentations
- remove music code--we can't redistribute the music in a pack :(
- remove old readme--writing the new docs tonight or tmrw

we got this!
---
 README.md | 51 +++------------------------------------------------
 1 file changed, 3 insertions(+), 48 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 185e2b9..6c19f2d 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,5 @@
-# tumble-alphatest (@MylesAndMore @CraivMan)
+# tumble
 
-please let me know if there is anything more you think we should add @CraivMan!
-once this list is complete and all bugs are fixed, we *should* be ready for release...
+## Overview  
 
-## generation  
-
-- [x] layers should be able to generate w/ "clumps" of blocks; instead of only one material as a whole
-  - [x] the clump size should be customizable (for later); be able to set a min/max val and it will choose randomly per each clump (not in config file yet, just internally)
-    - *Note: this is done through the amount of times each Material shows up in the List--there's no config for it.*
-- [x] make shovels generation actually work properly
-  - make different types of platforms (square, circle, multi-tiered, etc.); still should be pseudo-random
-- [x] make snowballs generation actually work properly (shocker)
-  - make three layers generate (same layer types as shovels, just multiple of them)
-
-## game realism  
-
-- [x] make the shovel in shovels mode not lose any durabilty
-- [x] make it so that you can't move until the game begins
-- [x] make the game blocks breakable very fast, but **not instantly--very important for balancing!!**
-  - Basically, just set a "cooldown" on both snowballs and shovels--not a long one--but one at that
-- [x] add infinite snowballs in the gamemanager for tumble mode  
-- [x] make it so that you can't remove any of the game items from your inventory
-- [x] make snowballs actually break blocks (duh)
-- [x] make the randomized mode logic
-- [x] make it so rounds end in a draw after 5m
-- [x] make it so that players get snowballs instead of shovels in shovels rounds after 2m 30s
-- [x] remove snowball knockback
-
-## game logic  
-
-- [x] make a Game class and object that we can initialize a new instance of with a gameType
-- [x] prevent players from joining/autojoining during a game
-- [x] keep track of when someone wins; start a new round when this happens
-- [x] keep track of how many wins each player has; end the game when a player reaches 3
-  - [x] add a section in the config for a place to tp the winning player
-    - [x] add logic to do this
-
-## configuration/customization
-
-- [x] add two configs where you can:
-  - [x] set if you want the game to auto-start
-  - [x] set the amt of players you want the game to auto-start at
-  - [x] program the auto-start (just add an if statement on the PlayerJoin listener to run the StartGame method on a certain amt of players in the config)  
-
-## etc  
-
-- [x] refactor EventListener null checker code
-  - if (TumbleManager.getGameWorld() == null && TumbleManager.getLobbyWorld() == null) { return; }
-- [x] add game music? but probably only for us; I feel like the og music must be copyrighted
+Cringe  
-- 
cgit v1.2.3