aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMyles <mylesandmore9@gmail.com>2024-08-01 20:52:15 -0500
committerMyles <mylesandmore9@gmail.com>2024-08-01 20:52:15 -0500
commitd3c2467476f92ad3c5bcbe8fb5aa8b568c971518 (patch)
tree20dff1d8e255f36a8eab1d07f3e9ea976083e1fa /README.md
parent839be68b900d46d52899c224a779fa90d06d6c74 (diff)
downloadTumble-d3c2467476f92ad3c5bcbe8fb5aa8b568c971518.tar.gz
Tumble-d3c2467476f92ad3c5bcbe8fb5aa8b568c971518.tar.bz2
Tumble-d3c2467476f92ad3c5bcbe8fb5aa8b568c971518.zip
LayerManager bugfixes/improvements
- test and fix LayerManager - add layer and within-layer weights - add docs for layers.tml in readme
Diffstat (limited to '')
-rw-r--r--README.md29
1 files changed, 23 insertions, 6 deletions
diff --git a/README.md b/README.md
index 52dc9c2..0f208d5 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ But in Tumble, you play on randomly generated layers of blocks, using shovels, s
## Setup
-1. [Download](https://github.com/MylesAndMore/tumble/releases) the plugin's JAR file and place it in your server's plugins directory.
+1. [Download](https://github.com/MylesAndMore/Tumble/releases) the plugin's JAR file and place it in your server's plugins directory.
2. Place the worlds for your lobby and arenas in your server's worlds directory.
- If you would like an experience similar to the original game, see [my guide](OG_GUIDE.md) for using the original worlds.
@@ -81,11 +81,11 @@ Each arena can contain the following locations:
Locations are stored using the following format:
```yaml
- location:
- x: 0.5
- y: 100
- z: 0.5
- world: worldName
+location:
+ x: 0.5
+ y: 100
+ z: 0.5
+ world: worldName
```
If a location is not specified, players will not be teleported by the plugin.
@@ -102,6 +102,23 @@ All plugin chat messages will have the `prefix` prepended to them.
Colors can be added using alternate color codes; for example, `&cRed Text` will appear red in-game.
+### layers.yml
+Stores data about the layers that will be generated in the game.
+
+Layers are stored using the following format:
+```yaml
+ores: # User-specified name of the layer
+ weight: 5 # Optional integer weight of the layer (1-...), used to determine how often it will be selected
+ materials: # List of materials (blocks) that will be used to generate the layer
+ - material: COBBLESTONE
+ weight: 5 # Optional integer weight of the material (1-...), used to determine how often it will be selected within the layer
+ - material: COAL_ORE
+ weight: 3
+ - material: IRON_ORE
+ # No weight specified, defaults to 1
+ # More materials...
+```
+
## Issues & Feedback
Feel free to report any bugs, leave feedback, ask questions, or submit ideas for new features on the Tumble [GitHub issues page](https://github.com/MylesAndMore/tumble/issues/new)!