Skip to main content

Config commands

/tardisconfig

ArgumentsDescriptionUsage
optionsList the TARDIS config options and values in chat. Where [config section] is one of modules, storage, creation, police_box, travel, preferences, dynmap, desktop, circuits, allow, growth, arch, siege, junk, abandon, archive, rechargers, autonomous_areas, display, conversions.
/tardisconfig options [config section]
reloadReload the TARDIS config from disk. Where [config name] is one of achievements, adaptive, artron, blaster, blocks, chameleon_guis, condensables, custom_consoles, flat_world, handles, items, kits, monsters, planets, recipes, rooms, shop, signs, tag, vortex_manipulator.
/tardisconfig reload [config name]
includeSet whether the specified world is included in time travel destinations.
/tardisconfig include [world]
excludeSet whether the specified world is excluded from time travel destinations.
/tardisconfig exclude [world]

Setting config options

Most TARDIS plugin config options can be set ingame or via the console, and take effect immediately.

There are three types of config options:

  1. Boolean values e.g. true or false
  2. String values e.g. the names of things, like the TARDIS key
  3. Integer values e.g. numbers, like the cost of a room

To use the /tardisconfig command to set config options, you use the syntax:

/tardisconfig [config option] [value]

For example, to set the TARDIS to never land on water you would type:

/tardisconfig land_on_water false

Config options:

The following values will be set in config.yml:

ConfigTypeDefault
debugbooleanfalse
Shows or hides extra messages in the server log
modules:
weeping_angelsbooleanfalse
Enables/disables the TARDIS Weeping Angels module
vortex_manipulatorbooleanfalse
Enables/disables the TARDIS Vortex Manipulator module
dynmapbooleanfalse
Enables/disables the TARDIS Dynmap module
chemistrybooleanfalse
Enables/disables the TARDIS Chemistry module
shopbooleanfalse
Enables/disables the TARDIS Shop module
sonic_blasterbooleanfalse
Enables/disables the TARDIS Sonic Blaster module
blueprintsbooleanfalse
Enables/disables the TARDIS blueprint permissions module
storage:
databasestringsqlite
Sets the database type the plugin uses. Valid values are sqlite and mysql
mysql:
Only applicable if database is set to mysql, otherwise this section can be ignored
hoststringlocalhost
Sets the host of the mysql database, where: localhost = the ip address or hostname of the MySQL server (if the MySQL server is on the same server as the Spigot server, you can usually use localhost
portnumber3306
Sets the mysql server port, where: 3306 = the port on which the MySQL server is running (usually 3306)
databasestringTARDIS
Sets the database type the plugin uses. Valid values are sqlite and mysql
userstringbukkit
Sets the user that connects to the mysql database
passwordstringmysecurepassword
Sets the password to connect to the mysql database
prefixstring
Sets the prefix added to the table names used in the mysql database. Spigot servers will generally only use one database, so to distinguish the TARDIS tables from other plugins this should probably be set to something like tardis_
use_SSLbooleanfalse
Sets whether to use an SSL connection to the MySQL database
creation:
create_worldsbooleanfalse
It is NOT recommended setting this to true! Sets whether TARDISes are created in their own separate worlds.
create_worlds_with_permsbooleanfalse
Sets whether TARDISes are created in their own separate worlds for players with the appropriate permission — tardis.create_world.
default_worldbooleantrue
Sets whether TARDISes are created in a shared world. Also required to be true to enable the Junk TARDIS and the abilty to abandon TARDISes.
default_world_namestringTARDIS_TimeVortex
Sets the name of the default world. This is only used if default_world is true.
border_radiusnumber256
Sets the distance of the WorldBorder barrier (only used if the plugin is installed on the server).
inventory_groupnumber0
If the Multiverse-Inventories plugin is enabled on the server, you can set the group that TARDIS worlds are added to when they are created.
add_permsbooleantrue
Sets whether a TARDIS world is assigned permissions when the server uses a permissions plugin that has per-world configuration — see Add permissions.
use_claystringWOOL
Sets whether the coloured wool in TARDIS console and room schematics is switched to stained terracotta or concrete instead. Valid options are WOOL, TERRACOTTA, and CONCRETE.
countnumber0
Sets the maximum number of times a player can build and destroy a TARDIS. If set to 0 there is NO maximum.
tips_limitnumber400
Sets the number of T.I.P.S slots to use. Must be one of 400, 800, 1200 or 1600.
areastringnone
If set to a pre-defined TARDIS area, it will set that area as the only place on the server that TARDISes can be created in.
enable_legacybooleantrue
Sets whether the legacy console schematics are available to build TARDIS interiors with.
check_for_homebooleantrue
Sets whether the TARDIS creation location is already set to another player's home location.
seed_block:
craftingbooleantrue
Sets whether players can craft TARDIS seed blocks.
legacybooleantrue
Sets whether server difficulty affects the 'lamp' crafting material. A value of true means the crafting material is always a Redstone Torch.
easystringREDSTONE_TORCH
normalstringSOUL_LANTERN
hardstringDRAGON_BREATH
Sets the 'lamp' craft material depending on the server difficulty.
police_box:
default_presetstringFACTORY
Sets the default preset that appears when the TARDIS is first created. See the Chameleon Presets page for values that can be set.
name_tardisbooleanfalse
Sets whether to put the player’s name on the Police Box sign.
use_nickbooleanfalse
Sets whether to use the player’s nick name on the Police Box sign.
view_interiorbooleanfalse
Sets whether player’s can view the TARDIS interior when opening hte exterior TARDIS door.
view_interior_uses_console_sizebooleanfalse
Sets whether the the interior view distance uses the interior console size or a deafult 16 blocks
materialisebooleantrue
Sets whether the TARDIS runs the materialising animation when it takes off and lands.
sign_colourstringWHITE
Sets the colour of the text on a TARDIS sign. Must be a valid ChatColor value, see https://hub.spigotmc.org/javadocs/spigot/org/bukkit/ChatColor.html
rebuild_cooldownnumber10000
Sets the minimum time (in server ticks) required between TARDIS rebuilds.
load_shellsbooleanfalse
Sets whether player’s can load Chameleon preset shells into the Shell room.
keep_chunk_force_loadedbooleantrue
Sets whether to keep the current location chunk of player’s Police Boxes force loaded.
travel:
include_default_worldbooleanfalse
Sets whether the default world is included in time travel destinations.
tp_radiusnumber500
Sets the maximum distance (in blocks) you can randomly time travel in the TARDIS. Note The actual values is about 4 times this (due to the multiplier repeater).
max_distancenumber29999983
Sets the maximum distance (in blocks) that can be used with the /tardistravel command. If the (vanilla) World Border distance is smaller this will be used instead.
chameleonbooleantrue
Sets whether the TARDIS police box can change its appearance to match its surroundings.
give_keybooleanfalse
Sets whether the TARDIS key is given when changing worlds (and using a multi-world inventory plugin).
the_endbooleanfalse
Sets whether the TARDIS is allowed to travel to The End worlds.
allow_end_after_visitbooleanfalse
If enabled, players may only fly to The End in the TARDIS if they've already been there once without it (i.e. End Portal) Note: End travel must be enabled (the_end: true) for this to take effect.
netherbooleanfalse
Sets whether the TARDIS is allowed to travel to Nether worlds.
allow_nether_after_visitbooleanfalse
If enabled, players may only fly to the Nether in the TARDIS if they've already been there once without it (i.e. Nether Portal). Note: Nether travel must be enabled (nether: true) for this to take effect.
land_on_waterbooleantrue
Sets whether the TARDIS will land on water in the Overworld.
timeoutnumber5
timeout_heightnumber135
Sets the maximum time in seconds a random location task can take. If the task times out then the Police Box location is set at the timeout_height value. This prevents the plugin crashing when using skyblock type worlds.
random_attemptsnumber30
Sets the maximum number of attempts to find a random location. This prevents the plugin crashing under certain circumstances.
exilebooleanfalse
Sets whether the TARDIS exile feature is enabled.
per_world_permsbooleanfalse
Sets whether players require the tardis.travel.[world] permission to travel to a world.
terminal_stepnumber1
Sets the 4 step values that the TARDIS Destination Terminal GUI uses, where the steps are 10 * step and 25 * step etc.
terminal:
redefinebooleanfalse
the_endstringworld
Sets whether the TARDIS is allowed to travel to The End worlds.
netherstringworld
Sets whether the TARDIS is allowed to travel to Nether worlds.
manual_flight_delaynumber60
Sets the server tick delay between having to click the repeaters in manual flight mode.
grace_periodnumber10
Sets the number of times players can use easy controls when the server is set to hard difficulty mode.
random_circuit:
xnumber5000
ynumber5000
Maximum +/- number of blocks the random location search will look between in x and z directions, so default will be -5000 to 5000 in both x and z directions. If the WorldBorder plugin is installed or a vaniila world border is in use, then those settings will be used instead.
no_destination_malfunctionsbooleantrue
Sets whether the TARDIS will malfunction if no valid random destination can be found with the current console settings.
preferences:
notify_updatebooleantrue
Sets whether to check for and notify opped players if there is a TARDIS plugin update.
languagestringen
Sets the language used for TARDIS message localisation. The plugin will look for a file named with this setting and the file extension .yml. Should be set to an international language code.
keystringGOLD_NUGGET
Sets the TARDIS key item. You can use any valid Bukkit Material ENUM. A list can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
any_keybooleanfalse
Sets whether any item can be used as the TARDIS key.
walk_in_tardisbooleantrue
Sets whether players can walk into the Police Box to enter the TARDIS. If set to false, clicking the door with the TARDIS key teleports you to the interior.
open_door_policybooleanfalse
Sets whether anyone can enter the TARDIS. If set to false (the default) only the Time Lord and their companions can enter the TARDIS.
use_worldguardbooleantrue
Sets whether the TARDIS interior becomes a protected WorldGuard region belonging to the player who created the TARDIS
respect_worldguardstringbuild
Sets whether time travelling respects protected WorldGuard regions. Valid values are none — no checking is performed, and any WorldGuard state flag, generally this will probably be build or entry.
respect_grief_preventionbooleantrue
Sets whether time travelling respects protected GriefPrevention claims.
respect_townystringnation
Sets whether time travelling respects protected Towny regions. Valid values are none — no checking is performed, wilderness — players can only land in wilderness, town — players can also land in a town they are a resident of, nation — players can land in any town that is in the same nation as their own town.
respect_worldborderbooleantrue
respect_factionsbooleantrue
Sets whether time travelling respects protected regions (if players do not have rights to build in an area, they will be denied access).
sfx_volumenumber10
Sets the default volume of the TARDIS Resource Pack sounds. Using 10 is the same volume as the default sounds, lower values make the sounds quieter.
difficultystringhard
Sets how hard it is for players to use the plugin. This usually affects the TARDIS crafting recipes, whether they can use certain commands and whether TARDIS functions are controlled by circuits being installed. Valid values are easy, medium and hard
strike_lightningbooleantrue
Sets whether a TARDIS recharge point will strike lightning when recharging a TARDIS.
freeze_cooldownnumber60
Sets the cool down period (in seconds) between uses of the Sonic Screwdriver’s player freeze function.
hads_damagenumber10
Sets the number of hits the Police Box will take before engaging HADS.
hads_distancenumber10
Sets the distnace in blocks the Police Box will travel when HADS is engaged.
malfunctionnumber3
Sets the percentage chance the TARDIS will malfunction when travelling.
malfunction_nethernumber3
malfunction_endnumber3
Sets the percentage chance a malfunction will deposit the TARDIS in the The End or the Nether.
use_default_condensablesbooleantrue
Sets whether to use the plugin settings for condenser values. If you want to set your own values, set this to false and edit condensables.yml
no_creative_condensebooleanfalse
Sets whether players can condense items in CREATIVE game mode.
no_enchanted_condensebooleanfalse
Sets whether players can condense enchanted items.
heal_speednumber200
Sets the heal speed in the Zero room. The default value of 200 means the player will gain half a heart every 200 ticks (10 seconds).
default_keystringeleventh
Sets the default key texture.
default_sonicstringeleventh
Sets the default sonic screwdriver texture.
render_entitiesbooleantrue
Sets whether mobs will be shown in the Rendering room.
nerf_pistons:
enabledbooleanfalse
Sets whether the plugin will attempt to prevent protected TARDIS blocks from being moved by pistons.
only_tardis_worldsbooleantrue
Sets whether all worlds are checked for pistons moving TARDIS blocks, or only TARDIS worlds
spawn_random_monstersbooleantrue
Sets whether monsters will randomly spawn in the TARDIS if door is left open.
spawn_limitnumber10
Sets the maximum number of monsters that can randomly spawn inside a TARDIS.
vortex_fallstringkill
Sets whether players are killed or teleported when they fall into the vortex in the TARDIS_TimeVortex world. Valid values are kill and teleport.
no_coordsbooleanfalse
Sets whether players will see the coordinates message when choosing a random destination.
chat_widthnumber55
Sets the maximum character width of a TARDIS message in the chat window.
dynmap:
Enables/disables the TARDIS Dynmap module
update_periodnumber30
updates_per_ticknumber10
desktop:
check_blocks_before_upgradebooleanfalse
Sets whether to compare the amount of block changes before allowing an upgrade.
block_change_percentnumber25
Sets the maximum percentage of block change compared to the original schematic.
circuits:
damagebooleanfalse
Sets whether circuits get damaged after each use. Setting this to false (the default) means circuits have unlimited uses.
uses:
<circuit>number20
Sets the maximum number of uses a circuit has before it is vapourised. Setting this to 0 gives unlimited uses for that circuit.
allow:
mob_farmingbooleantrue
Sets whether players can farm mobs when entering the TARDIS.
spawn_eggsbooleantrue
Sets whether the player receives mob spawn eggs when TARDIS mob farming (and there is no farm room grown).
emergency_npcbooleantrue
Sets whether the Emergency Program One feature is enabled.
external_gravitybooleanfalse
Sets whether the Gravity Wells can be set up outside of the TARDIS.
achievementsbooleantrue
Sets whether players can gain TARDIS achievements.
autonomousbooleantrue
Sets whether players can use the autonomous function.
hadsbooleantrue
Sets whether the TARDIS can escape hostile actions.
tp_switchbooleantrue
Sets whether players can set and switch resource packs when entering and exiting the TARDIS.
all_blocksbooleanfalse
Sets whether the chameleon circuit is allowed to use precious blocks such as GOLD and DIAMOND. This also affects whether players are allowed to change the TARDIS Key to any item — if set to false, then keys are restricted to the items listed under keys: in blocks.yml.
sfxbooleantrue
Sets whether sound effects are played in the TARDIS interior — this overrides user preferences if turned off.
wg_flag_setbooleantrue
Sets whether players can set the build flag (allow, deny) in their TARDIS region.
zero_roombooleanfalse
Sets whether players can grow a Zero room. If this is set to true using the /tardisconfig zero_room true command, the plugin wil attempt to create the TARDIS_Zero_Room world if it doesn’t yet exist.
power_downbooleantrue
Sets whether players can power down their TARDIS.
power_down_on_quitbooleanfalse
Sets whether a player’s TARDIS automatically powers down when the player leaves the server.
player_difficultybooleantrue
Sets whether players can use the /tardisprefs difficulty [easy | hard] command to change their personal difficulty setting. See this ticket for the reasoning behind it all.
invisibilitybooleantrue
Sets whether players can use the invisibility Chameleon preset. See Invisibility for more info.
guardiansbooleanfalse
Sets whether players can farm guardians when entering the TARDIS, and whether guardians will randomly spawn in the pool room if the door is left open.
village_travelbooleanfalse
Sets whether players can use the /tardistravel [structure|village] command to time travel to a village or other Minecraft structure.
3d_doorsbooleanfalse
Sets whether TARDIS owners can see their door when the exterior is set to the INVISIBLE preset. They must be wearing 3D Glasses and looking at the block that the door would normally be placed on.
repairbooleantrue
Sets whether players can repair a damaged TARDIS interior.
weather_setbooleanfalse
Sets whether players can use the /tardisweather command or the TARDIS Weather GUI.
force_fieldnumber8
If set to greater than 0, determines whether players can activate the TARDIS force field and sets the range of the force field effect. Set to 0 to disable.
admin_bypassbooleanfalse
Sets whether players the permission tardis.admin can bypass TARDIS travel location and plugin protection checks.
perception_filterbooleantrue
Sets whether players can use the perception filter.
growth:
gravity_max_distancenumber15
gravity_max_velocitynumber5
Sets sets the maximum distance and velocity a gravity well can be set to.
rooms_require_blocksbooleanfalse
Sets whether growing a room requires the player to condense the materials required to grow the room in the TARDIS condenser.
rooms_condenser_percentnumber100
Sets the percentage of the actual blocks that a player needs to condense if rooms_require_blocks: true
return_room_seedbooleantrue
Sets whether the room seed block is returned to the player when they jettison the room.
room_speednumber4
Sets the speed (in blocks per second) at which rooms are grown. Maximum speed is 20 which is one block per tick.
delay_factornumber1
Sets the delay between growing multiple rooms.
ars_limitnumber1
Sets the maximum number of rooms that can be reconfigured at a time.
arch:
enabledbooleantrue
Sets whether the plugin will attempt to prevent protected TARDIS blocks from being moved by pistons.
min_timenumber20
switch_inventorybooleantrue
clear_inv_on_deathbooleanfalse
siege:
enabledbooleantrue
Sets whether the plugin will attempt to prevent protected TARDIS blocks from being moved by pistons.
breedingnumber0
If this is set higher than 0, this is the percentage chance that twins will be born when animals breed
growthnumber0
butcherbooleanfalse
Sets whether any hostile mobs inside the TARDIS will be butchered when Siege mode is engaged
creeperbooleanfalse
Sets whether (when the TARDIS runs out of energy) the Artron creeper will be sacrificed to give the TARDIS an energy boost
healingbooleanfalse
Sets whether players inside the TARDIS receive a healing pick-me-up
texturebooleanfalse
Sets whether the desktop theme is changed when Siege mode is engaged
junk:
enabledbooleantrue
Sets whether the plugin will attempt to prevent protected TARDIS blocks from being moved by pistons.
returnnumber-1
Sets the time in seconds that the Junk TARDIS will automatically return to its ‘home’ location. If this is less than 0 and the Junk TARDIS will not automatically return home.
particlesbooleantrue
Sets whether the Junk TARDIS displays a particle effect when travelling
abandon:
enabledbooleantrue
Sets whether the plugin will attempt to prevent protected TARDIS blocks from being moved by pistons.
reduce_countbooleantrue
archive:
enabledbooleantrue
Sets whether the plugin will attempt to prevent protected TARDIS blocks from being moved by pistons.
limitnumber3
display:
allstring&6X&7%X% &6Y&7%Y% &6Z&7%Z% &6F&7%FACING% (%FACING_XZ%) %TARGET_BLOCK%

Artron config values

The following values will be set in artron.yml:

ConfigTypeDefault
playernumber25
Sets the amount of time lord energy a player absorbs from the time vortex each time they time travel.
randomnumber75
travelnumber100
comeherenumber400
hidenumber500
autonomousnumber100
Sets the amount of energy the different forms of time travel consume. The options are: random locations, any /tardistravel, /tardis comehere, /tardis hide commands, and autonomous homing.
nether_minnumber4250
the_end_minnumber5500
Sets the minimum amount of energy the TARDIS Artron Energy Capacitor must have before players can time travel to the Nether or The End.
recharge_distancenumber20
Sets the maximum distance in blocks, a Police Box can be from a recharge beacon in order to start recharging.
lightning_rechargenumber300
Sets the amount of energy TARDISes receive if they are within the recharge_distance of a natural lightning strike.
creeper_rechargenumber150
Sets the amount of energy players receive if they kill a charged creeper.
full_chargenumber5000
Sets the amount of energy a fully charged TARDIS Artron Energy Capacitor holds.
full_charge_itemstringNETHER_STAR
Sets the item that fully charges the Energy Capacitor when you right-click the Artron button with it.
siege_transfernumber10
Sets the minimum amount of Time Lord energy needed to transfer to the Siege block. This is a percentage of full_charge. Default is 10% (500).
siege_depletenumber100
Sets the amount of energy Siege mode uses every cycle. Default is 100
siege_creepernumber150
Sets the amount of energy gained when the Artron Creeper is sacrificed. The default is 150. Only relevant if the main config option siege.creeper is set to true.
siege_ticksnumber1500
Sets the amount of time in server ticks that the energy depletion / siege mode healing cycle takes. The default is 1500 (or every 1.25 minutes)
standbynumber5
Sets how much energy is used per cycle when the TARDIS is in standby power mode.
standby_timenumber6000
Sets how often energy is removed when the TARDIS is in standby mode. If standby_time is set to 0, then no energy is removed.
jettisonnumber75
Sets the percentage of energy the TARDIS gets back when a room is jettisoned.
jettison_seedstringTNT
Sets the block required to manually jettison a room.
renderernumber250
Sets the cost to use the Renderer room.
zeronumber250
Sets the cost to transmat to the TARDIS Zero room.
upgrades:
ancientnumber5000
arsnumber5000
biggernumber7500
budgetnumber5000
cavenumber5000
coppernumber20000
coralnumber8000
deltanumber7500
deluxenumber10000
divisionnumber7500
eleventhnumber10000
endernumber5000
factorynumber7500
fugitivenumber7500
hospitalnumber5000
masternumber10000
mechanicalnumber7500
originalnumber5000
planknumber5000
pyramidnumber5000
redstonenumber7500
rotornumber5000
steampunknumber5000
thirteenthnumber8000
tomnumber5000
twelfthnumber7500
warnumber5000
weatherednumber5000
customnumber10000
legacy_deluxenumber10000
legacy_redstonenumber8000
legacy_biggernumber7500
legacy_eleventhnumber10000
Sets the energy cost to upgrade / crossgrade to a different console when using the Desktop Theme changer.
archive:
tallnumber10000
smallnumber5000
mediumnumber7500
Sets the energy cost to use different archive console sizes when using the Desktop Theme changer.
template:
mediumnumber2500
Sets the energy cost to use different archive console sizes when using the Desktop Theme changer.
smallnumber1666
tallnumber3333
just_wall_floornumber50
If a player is just changing the walls and floor, then just_wall_floor sets the percentage the cost is reduced.
artron_furnace:
cook_timenumber0.5
Sets the cook time for items smelted with Artron Storage Cells — 0.5 is half the normal time, 2.0 would be twice normal speed (longer), 1.0 = normal cook time (same as coal)
burn_timenumber0.5
Sets the length of time an Artron Storage Cell will burn for — as above fractions (0.5) will give shorter life to the cells, > 1 will extend the burn time, 1.0 = normal burn time (same as coal)
burn_limitnumber100000
Sets the maximum amount of burn time a fully charged Artron Storage Cell can have.
particlebooleantrue
Sets whether the Artron Furnace block displays particles.
sonic_generator:
standardnumber10
bionumber10
diamondnumber10
emeraldnumber10
redstonenumber10
painternumber10
ignitenumber10
arrownumber10
knockbacknumber10
brushnumber10
Sets the energy costs for the sonic generator as a percentage of the full_charge option.
shellnumber500
Sets the cost to use the Shell room constructor.
custard_creamnumber25
Sets the cost to dispense a custard cream.
backdoornumber100
Sets the cost to use the TARDIS back door.

Reloading the config

If you have made changes to the config file by manually editing it, you should use the reload command to reload the changes. Type:

/tardisconfig reload
note

Do not use the server /reload command or the manual changes you have made will be overwritten when the TARDIS config is saved when it is disabled.