diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 68 |
1 files changed, 33 insertions, 35 deletions
@@ -1,3 +1,17 @@ +## temporary stuff (not ready for merge) +### known issues +- [ ] file writing not fully implemented (just need to call ArenaManager.write() somewhere) +- [ ] issues with join command +- [ ] no config validation + +### todo +- [ ] improve inventory saving +- [ ] improve Game.leave() method +- [ ] perhaps replace spectator mode with survival flight +- [ ] clean up and make config managers uniform in structure +- [ ] improve language flow +- [ ] put javadoc comments everywhere + # Tumble ## Overview @@ -6,11 +20,11 @@ Tumble is a Spigot/Paper plugin that aims to recreate the Tumble minigame from t ## What *is* Tumble? -If you've never heard of it, [Tumble](https://minecraft.wiki/w/Tumble) is a twist on the classic Minecraft minigame of spleef, where the objective is to break the blocks under your opponents. But in Tumble, you play on randomly generated layers of blocks, using shovels, snowballs, or both to try and eliminate your opponents. +If you've never heard of it, [Tumble](https://minecraft.wiki/w/tmbl) is a twist on the classic Minecraft minigame of spleef, where the objective is to break the blocks under your opponents. But in Tumble, you play on randomly generated layers of blocks, using shovels, snowballs, or both to try and eliminate your opponents. ## Features -- Choose from three different game modes present in the original game--shovels, snowballs, and mixed +- Choose from three different game modes present in the original game: shovels, snowballs, and mixed - Four types of random layer generation - 15 unique, themed layer varieties - Quick and easy setup and use @@ -21,51 +35,35 @@ If you've never heard of it, [Tumble](https://minecraft.wiki/w/Tumble) is a twis ## Setup -1. Simply [download](https://github.com/MylesAndMore/Tumble/releases) the plugin's JAR file and place it in your server's plugins directory. -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. +1. Simply [download](https://github.com/MylesAndMore/tmbl/releases) the plugin's JAR file and place it in your server's plugins directory. +2. Load the worlds for your lobby and arenas. - - If you would like an experience similar to the original game, see [my guide](https://github.com/MylesAndMore/tumble/blob/main/og-guide.md) for using the original worlds. + - If you would like an experience similar to the original game, see [my guide](https://github.com/MylesAndMore/tmbl/blob/main/OG-GUIDE.md) 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 using a plugin like Multiverse. This can be done with the command ```/mv import <your-world-name> normal```. -5. Now you need to tell Tumble where your lobby is and where your game arena is. You can do this by going to the center positions and running ```/tumble-config set lobbyWorld``` and ```/tumble-config add <arenaname>``` respectively. +5. Now you need to tell Tumble where your lobby is and where your game arena is. You can do this by going to the center positions and running ```/tmbl-config set lobbyWorld``` and ```/tmbl-config add <arenaname>``` respectively. 6. **VERY IMPORTANT:** The plugin will teleport players to the world and generate the game's blocks around the point you set. Ensure that your spawn points are clear of any obstructions, and that a 20x20x20 cube is cleared out **Any blocks in this area will be destroyed when the game begins.** -7. You're done! You can now start games with the command ```/tumble-start <arenaname> mixed```. +7. You're done! You can now start games with the command ```/tmbl start <arenaname> mixed```. Scroll down for more options to configure your game. -## Commands/Permissions - -- **tumble-join**: - - Description: Joins a Tumble match. - - Usage: `/tumble-join <arenaName> [gameType]` - - Permission: tumble.join -- **tumble-leave**: - - Description: Quits a Tumble match. - - Usage: `/tumble-leave` - - Permission: tumble.leave -- **tumble-forcestart**: - - Description: Force starts a Tumble match. - - Usage: `/tumble-forcestart [arenaName]` - - Permission: tumble.forcestart -- **tumble-forcestop**: - - Description: Force stops a Tumble match. - - Usage: `/tumble-forcestop [arenaName]` - - Permission: tumble.forcestop -- **tumble-config**: - - Description: Modify arenas and worlds. - - Usage: `/tumble-config <add|set|disable|delete> <data>` - - Permission: tumble.config -- **tumble-reload**: - - Description: Reloads the plugin's config. - - Usage: `/tumble-reload` - - Permission: tumble.reload +## Commands / Permissions + +| Command | Description | Permission | +|------------------------------------------------|-----------------------------------|---------------------| +| `/tmbl join <arenaName> [gameType]` | Join a Tumble match. | `tumble.join` | +| `/tmbl leave` | Quit a Tumble match. | `tumble.leave` | +| `/tmbl forcestart [arenaName]` | Force start a Tumble match. | `tumble.forcestart` | +| `/tmbl forcestop [arenaName]` | Force stop a Tumble match. | `tumble.forcestop` | +| `/tmbl config <add/set/disable/delete> <data>` | Modify arenas and worlds in game. | `tumble.config` | +| `/tmbl reload` | Reload the plugin's config. | `tumble.reload` | ## Configuration -Use `/tumble-config` for modifying the config in-game. See available options with the tab auto complete feature +Use `/tmbl config` for modifying the config in-game. See available options with the tab auto complete feature See the comments inside config,yml for manual editing ## Issues & Feedback -Feel free to report any bugs, leave feedback, ask questions, or submit ideas for new features on our [GitHub issues page](https://github.com/MylesAndMore/tumble/issues/new)! +Feel free to report any bugs, leave feedback, ask questions, or submit ideas for new features on our [GitHub issues page](https://github.com/MylesAndMore/tmbl/issues/new)! |