Limits/README.md

84 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2019-02-07 08:26:57 +01:00
# Limits
2019-08-08 16:04:27 +02:00
[![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/Limits)](https://ci.codemc.org/job/BentoBoxWorld/job/Limits/)
2019-02-07 08:26:57 +01:00
Add-on for BentoBox to limit island blocks and entities in GameModes like BSkyBlock and AcidIsland. This add-on will work
in any game mode world.
## How to use
1. Place the Limits addon jar in the addons folder of the BentoBox plugin
2. Restart the server
3. The addon will create a data folder and inside the folder will be a config.yml
4. Edit the config.yml how you want.
5. Restart the server if you make a change
2019-02-09 19:14:22 +01:00
## Commands
There is a user command and an admin command called "limits". Admins can check the limits of a specific island owner. Both show a GUI panel with the limits and the current count.
## Setup - Config.yml
2019-02-07 08:26:57 +01:00
The config.yml has the following sections:
* blocklimits
* worlds
* entitylimits
### blocklimits
This section lists the maximum number of blocks allowed for each block material. Do not use non-block materials because they will not work. The limits apply to all game worlds.
### worlds
This section lists block limits for specific worlds. You must name the world specifically, e.g. AcidIsland_world and then list the materials and the limit.
### entitylimits
2019-02-09 19:14:22 +01:00
Coming soon!
## Permissions
Island owners can have exclusive permissions that override the default or world settings. The format is:
Format is `GAME-MODE-NAME.island.limit.MATERIAL.LIMIT`
example: `bskyblock.island.limit.hopper.10`
Permissions activate when the player logs in.
2019-02-09 19:30:02 +01:00
Usage permissions are (put the gamemode name, e.g. acidisland at the front):
2019-02-09 19:14:22 +01:00
```
2019-02-09 19:30:02 +01:00
GAMEMODE_NAME.limits.player.limits:
2019-02-09 19:14:22 +01:00
description: Player can use limits command
default: true
2019-02-09 19:30:02 +01:00
GAMEMODE_NAME.limits.admin.limits:
2019-02-09 19:14:22 +01:00
description: Player can use admin limits command
default: op
```
## Items that cannot be limited
Some items cannot be limited (right now). The reasons are usually because there are too many ways to remove the item without it being tracked. If you are a programmer and can work out how to fix these, then please submit a PR!
* Primed TNT
* Evoker Fangs
* Llama Spit
* Dragon Fireball
* Area Effect Cloud
* Ender signal
* Small fireball
* Fireball
* Thrown Exp Bottle
* Shulker Bullet
* Wither Skull
* Tridents
* Arrows
* Spectral Arrows
* Snowballs
* Eggs
* Leashes
* Ender crystals
* Ender pearls
* Ender dragon
* Item frames
* Paintings