Updated readme file to BentoBox format

This commit is contained in:
tastybento 2019-01-31 08:11:39 -08:00
parent b9d1d9faad
commit eaa1d7b133
1 changed files with 24 additions and 18 deletions

View File

@ -10,19 +10,22 @@ Greenhouses are made out of glass and must contain the blocks found in the Biome
* Craft your own self-contained biome greenhouse on an island (or elsewhere if you like) * Craft your own self-contained biome greenhouse on an island (or elsewhere if you like)
* Greenhouses can grow plants that cannot normally be grown, like sunflowers * Greenhouses can grow plants that cannot normally be grown, like sunflowers
* Friendly mobs can spawn if your greenhouse is well designed - need slimes? Build a swamp greenhouse! * Friendly mobs can spawn if your greenhouse is well designed - need slimes? Build a swamp greenhouse!
* Blocks change in biomes - dirt becomes sand in a desert, dirt becomes clay in a river, for example. * Blocks change in biomes over time - dirt becomes sand in a desert, dirt becomes clay in a river, for example.
* Greenhouses can run in multiple worlds. * Greenhouses can run in multiple worlds.
* Easy to use GUI shows greenhouse recipes (/g) * Easy to use GUI shows greenhouse recipes (e.g. **/is greenhouses**)
* Admins can fully customize biomes and recipes * Admins can fully customize biomes and recipes
## How to Build A Greenhouse (Simple version) ## How to Build A Greenhouse
This example is for when you are in the BSkyBlock world. For AcidIsland, just use /ai instead of /island.
1. Make glass blocks and build a rectangular set of walls with a flat roof. 1. Make glass blocks and build a rectangular set of walls with a flat roof.
2. Put a hopper in the wall or roof. 2. Put a hopper in the wall or roof.
3. Put a door in the wall so you can get in and out. 3. Put a door in the wall so you can get in and out.
4. Type /g and read the rules for the greenhouse you want. 4. Type **/island greenhouses** and read the rules for the greenhouse you want.
5. Exit the GUI and place blocks, water, lava, and ice so that you make your desired biome. 5. Exit the GUI and place blocks, water, lava, and ice so that you make your desired biome.
6. Type /g again and click on the biome to make it. 6. Type **/island greenhouses** again and click on the biome to make it.
7. Type **/island greenhouses help** to see other options.
### Once made: ### Once made:
@ -63,10 +66,10 @@ This version of Greenhouses is an add-on for BentoBox and will not run stand-alo
5. The addon will make a data folder called greenhouses. Open that folder. 5. The addon will make a data folder called greenhouses. Open that folder.
6. Check **config.yml** and edit to be what you want, note the list of world names. 6. Check **config.yml** and edit to be what you want, note the list of world names.
7. Configure the **biomes.yml** if you wish (advanced). 7. Configure the **biomes.yml** if you wish (advanced).
8. Type **/gadmin reload** in the game to reload the config or restart the server. 8. Type **/bsbadmin greenhouses reload** in the game to reload the config or restart the server.
9. Done! 9. Done!
To make your first greenhouse, build a glass box and type **/g make** to see what kind of greenhouse you get. Type **/g** to see the recipes. To make your first greenhouse, build a glass box and type **/is greenhouses make** to see what kind of greenhouse you get. Type **/is greenhouses** to see the recipes.
## Upgrading ## Upgrading
@ -74,26 +77,29 @@ Read the file release notes for changes and instructions on how to upgrade.
## Player Commands ## Player Commands
* **/greenhouse** or **/g** can be used for short. Add these commands to /island, /ai:
* **/greenhouse help** - lists these commands
* **/greenhouse make**: Tries to make a greenhouse by finding the first valid recipe * **greenhouses help** - lists these commands
* **/greenhouse remove**: Removes a greenhouse that you are standing in if you are the owner * **greenhouses make**: Tries to make a greenhouse by finding the first valid recipe
* **/greenhouse list**: Lists all the recipes available * **greenhouses remove**: Removes a greenhouse that you are standing in if you are the owner
* **/greenhouse recipe**: Displays the recipe GUI - clicking on a recipe will try to make a greenhouse * **greenhouses list**: Lists all the recipes available
* **greenhouses recipe**: Display the recipe GUI - clicking on a recipe will try to make a greenhouse
## Admin Commands ## Admin Commands
* **/gadmin reload** : Reloads config files Use after the game mode admin command, e.g. /bsb or /acid
* **/gadmin info <player>**: provides info on the player
* **/gadmin info**: provides info on the greenhouse you are in * **greenhouses reload** : Reloads config files
* **greenhouses info <player>**: provides info on the player's island greenhouses
* **greenhouses info**: provides info on the greenhouse you are in
## Permissions ## Permissions
Permission to use specific biomes can be added in biomes.yml. Permission to use specific biomes can be added in biomes.yml.
For example, the permission for the Nether (Hell) biome is **greenhouses.biome.nether** and is set here: For example, the permission for the Nether biome is **greenhouses.biome.nether** and is set here:
HELL: NETHER:
permission: greenhouses.biome.nether permission: greenhouses.biome.nether