-
-
Notifications
You must be signed in to change notification settings - Fork 4
Getting started
Thank you for using BigDoorOpener.
With this plugin you can open doors under many conditions and even combine them.
To use BDO simply drop it in your plugin folder. Make sure that you have BigDoors installed as well.
There are some third party apis which are also available. These can be installed as well (Optinal)
- World guard 7.0+ for a special region condition.
- PlaceholderAPI
Configuration is fairly easy. You may want to change the language. I recommend to set the other entries on their default values.
# Dont touch it or at least dont complain when everything burns.
# No version = 1.x
# version 1 = 2.x
version: 1
# Get a simple notify, when a new build is available. Keeping this enabled is highly recommended.
checkUpdates: true
# The refresh rate of the door state. 1 sec = 20 ticks.
# This means a refresh rate of 20 would result in a state update every second.
# That should be perfectly fine, unless you have thousands of doors.
# The amount of doors updated every tick will be doorAmount / refresh rate or at least one.
refreshRate: 20
# Your desired language.
language: en_US
# Send anonymized metrics to bStats.
# With enabling this you allow me to see which features are used. It also motivated me to develop this plugin further.
# It also helps me to decide which feature should get an update.
enableMetrics: true
# This is the size of caches JS operations.
# If you use custom evaluators I recommend to set this to at least 200
# If you use placeholder evaluators I recommend to set this at least to 400
# If you use both I recommend to set this at least to 600
# If you have many doors with custom or placeholder evaluators you may increase this to reduce operations.
jsCacheSize: 400
# We save your doors here. If it is empty you should change this :P
doors:You may also want to set the Permissions
Please have a look at the Command Sheet for further command usage.
The command has full tab complete support. It will always suggest your next action.
To create a door you have to decide which condition you want to use. Some conditions are combined to a group some are not. You can choose one condition for every group. You can not use two item conditions on one door for example.
When you use the bdo setCondition <doorId> <condition> <condition values> command to add the condition to the door.
And thats it you have created you first conditional door.
The door you created has a OR evaluator. Maybe you want to change this with the bdo setEvaluator <doorId> <evaluator type> <args> command.
When you want to reuse settings of a door you can use the bdo cloneDoor <source> <target> command to copy all settings of a door to another. When you want to only copy the conditions use the bdo copyConditions <source> <target> [condition] command.
Sometimes it may happen that the door should stay open a while when opened. You can use the bdo stayOpen <doorId> <seconds> command to set the amount of seconds the door will be open.