TARDIS

A Bukkit plugin for all Doctor Who fans — create and use a TARDIS! It’s bigger on the inside!

View the Project on GitHub eccentricdevotion/TARDIS

Admin commands

/tardisadmin

To view specific TARDIS plugin configuration options:

/tardisadmin config [configuration section]

Where [configuration section] is one of:

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 /tardisadmin command to set config options, you use the syntax:

/tardisadmin [config option] [value]

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

/tardisadmin land_on_water false

Config options:

The following values will be set in config.yml:

Option Type Default Value
debug boolean false
  Shows or hides extra messages in the server log
storage:
    database string sqlite
  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
        url string mysql://localhost:3306/TARDIS
  Sets the url to the mysql database
        user string bukkit
  Sets the user that connects to the mysql database
        password string minecraft
  Sets the password to connect to the mysql database
creation:
    create_worlds boolean true
  Sets whether TARDISes are created in their own separate worlds. Requires the TARDISChunkGenerator plugin and a multi-world plugin.
    create_worlds_with_perms boolean false
  Sets whether TARDISes are created in their own separate worlds for players with the appropriate permission — tardis.create_world.
    default_world boolean false
  Sets whether TARDISes are created in a shared world.
    default_world_name string TARDIS_TimeVortex
  Sets the name of the default world. This is only used if default_world is true.
    border_radius integer 256
  Sets the distance of the WorldBorder barrier (only used if the plugin is installed on the server).
    gamemode string suvival
  Sets the gamemode of TARDIS worlds when they are created.
    keep_night boolean true
  Sets whether to keep the TARDIS world in perpetual night.
    inventory_group string '0'
  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_perms boolean true
  Sets whether a TARDIS world is assigned permissions when the server uses a permissions plugin that has per-world configuration — see Add permissions.
    custom_schematic boolean false
  Sets whether the server will use a custom TARDIS console schematic — see Schematics.
    custom_schematic_seed string OBSIDIAN
  Sets the material for crafting the custom TARDIS console seed block.
    custom_creeper_id integer 138
  Sets the block id that the plugin should look for in the custom schematic to spawn the Artron Capacitor charged creeper on.
    use_block_stack boolean false
  Sets whether players can use the legacy method of creating a TARDIS.
    use_clay string WOOL
  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.
    count integer 0
  Sets the maximum number of times a player can build and destroy a TARDIS. If set to 0 there is NO maximum.
    tips_limit integer 400
  Sets the number of T.I.P.S slots to use. Must be one of 400, 800, 1200 or 1600.
police_box:
    name_tardis boolean false
  Sets whether to put the player’s name on the Police Box sign.
    wall_id integer 35
  Sets the default material of the Police Box walls. Only applicable if use_block_stack: true
    wall_data integer 11
  Sets the default damage value of the Police Box walls. Only applicable if use_block_stack: true
    lamp integer 50
  Sets the default material of the Police Box lamp. Only applicable if use_block_stack: true
    platform_id integer 35
  Sets the default material of the Police Box safety platform.
    platform_data integer 8
  Sets the default damage value of the Police Box safety platform.
  Sets whether the TARDIS police box simulates ’de/re-materialising’ when travelling.
    confirm_timeout integer 8
  Sets the number of seconds the player has to type the /tardis exterminate command when destroying a TARDIS.
    sign_colour string WHITE
  Sets the colour of the text on a TARDIS sign. Must be a valid ChatColor value, see http://jd.bukkit.org/rb/apidocs/org/bukkit/ChatColor.html
travel:
    include_default_world boolean false
  Sets whether the default world is included in time travel destinations.
    tp_radius integer 500
  Sets the maximum distance (in blocks) you can time travel in the TARDIS. Note The actual values is about 4 times this (due to the multiplier repeater).
    platform boolean true
  Sets whether a platform is created outside the Police Box door if the exit is located over AIR or WATER — this overrides user preferences if turned off.
    chameleon boolean true
  Sets whether the TARDIS police box can change its appearance to match its surroundings.
    give_key boolean false
  Sets whether the TARDIS key is given when changing worlds (and using a multi-world inventory plugin).
    the_end boolean false
  Sets whether the TARDIS is allowed to travel to The End worlds.
    nether boolean false
  Sets whether the TARDIS is allowed to travel to Nether worlds.
    land_on_water boolean true
  Sets whether the TARDIS will land on water in the Overworld.
    timeout integer 5
    timeout_height integer 135
  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_attempts integer 30
  Sets the maximum number of attempts to find a random location. This prevents the plugin crashing under certain circumstances.
    exile boolean false
  Sets whether the TARDIS exile feature is enabled.
    per_world_perms boolean false
  Sets whether players require the tardis.travel.[world] permission to travel to a world.
    terminal_step integer 1
  Sets the 4 step values that the TARDIS Destination Terminal GUI uses, where the steps are 10 * step and 25 * step etc.
preferences:
    key string GOLD_NUGGET
  Sets the TARDIS key item. You can use any valid Bukkit Material ENUM. A list can be found here: http://jd.bukkit.org/apidocs/org/bukkit/Material.html
    use_worldguard boolean true
  Sets whether the TARDIS interior becomes a protected WorldGuard region belonging to the player who created the TARDIS.
    respect_worldguard string build
  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_towny string nation
  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_worldborder boolean true
    respect_factions boolean true
  Sets whether time travelling respects protected regions (if players do not have rights to build in an area, they will be denied access).
    sfx_volume integer 10
  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.
    difficulty string hard
  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 and hard
    strike_lightning boolean true
  Sets whether a TARDIS recharge point will strike lightning when recharging a TARDIS.
    freeze_cooldown integer 60
  Sets the cool down period (in seconds) between uses of the Sonic Screwdriver’s player freeze function.
    hads_damage integer 10
  Sets the number of hits the Police Box will take before engaging HADS.
    hads_distance integer 10
  Sets the distnace in blocks the Police Box will travel when HADS is engaged.
    malfunction integer 3
  Sets the percentage chance the TARDIS will malfunction when travelling.
    malfunction_nether integer 3
    malfunction_end integer 3
  Sets the percentage chance a malfunction will deposit the TARDIS in the The End or the Nether.
    use_default_condensables boolean true
  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
    heal_speed integer 200
  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)
allow:
    mob_farming boolean true
  Sets whether players can farm mobs when entering the TARDIS.
    spawn_eggs boolean true
  Sets whether the player recieves mob spawn eggs when TARDIS mob farming (and there is no farm room grown).
    emergency_npc boolean true
  Sets whether the Emergency Program One feature is enabled. This setting will be disabled automatically if the Citizens plugin is not found.
    achievements boolean true
  Sets whether players can gain TARDIS achievements.
    autonomous boolean true
  Sets whether players can use the autonomous function.
    hads boolean true
  Sets whether the TARDIS can escape hostile actions.
    tp_switch boolean true
  Sets whether players can set and switch resource packs when entering and exiting the TARDIS.
    all_blocks boolean false
  Sets whether the chameleon circuit is allowed to use precious blocks such as GOLD and DIAMOND.
    sfx boolean true
  Sets whether sound effects are played in the TARDIS interior — this overrides user preferences if turned off.
    wg_flag_set boolean true
  Sets whether sound effects are played in the TARDIS interior — this overrides user preferences if turned off.
    zero_room boolean false
  Sets whether players can grow a Zero room. If this is set to true using the /tardisadmin zero_room true command, the plugin wil attempt to create the TARDIS_Zero_Room world if it doesn’t yet exist.
    external_gravity boolean false
  Sets whether players can use the /tardisgravity command outside of their TARDIS.
growth:
    gravity_max_distance integer 16
    gravity_max_velocity integer 5
  Sets sets the maximum distance and velocity a gravity well can be set to.
    rooms_require_blocks boolean true
  Sets whether growing a room requires the player to condense the materials required to grow the room in the TARDIS condenser.
    rooms_condenser_percent integer 100
  Sets the percentage of the actual blocks that a player needs to condense if rooms_require_blocks: true
    return_room_seed boolean true
  Sets whether the room seed block is returned to the player when they jettison the room.
    room_speed integer 4
  Sets the speed (in blocks per second) at which rooms are grown. Maximum speed is 20 which is one block per tick.

Artron config values

The following values will be set in artron.yml:

    full_charge_item string NETHER_STAR
  Sets the item that when clicked on the TARDIS Artron Energy button, boosts the Capacitor to 100%.
    full_charge string NETHER_STAR
  Sets the Artron Energy Capacitor’s full amount.
    lightning_recharge integer 300
    creeper_recharge integer 150
  Sets the amount of energy gained form natural lightning strikes and given to players for killing a charged creeper.
    nether_min integer 4250
    the_end_min integer 5500
  Sets the minmum Artron Energy level required to travel to the Nether and The End.
    player integer 25
  Sets the amount of Artron Energy a player receives each time they time travel. If the Minecraft/CraftBukkit version does not include beacon blocks, then this amount is multiplied by 10)
    random integer 75
    travel integer 100
    comehere integer 400
    hide integer 500
    autonomous integer 100
    backdoor integer 100
  Sets the Artron energy costs for each of these forms of time travel.
    recharge_distance string 20
  Sets the maximum distance a TARDIS can be from a beacon in order to recharge. This is also the distance from a natural lightning strike, for the TARDIS to gain bonus energy.
    jettison integer 75
  Sets the percentage of the original cost of a room you get back when jettisoning it.
    jettison_seed string TNT
  Sets the jettison seed item. You can use any valid Bukkit Material ENUM. A list can be found here: http://jd.bukkit.org/apidocs/org/bukkit/Material.html.
    renderer integer 250
  Sets the cost to use the Exterior Renderer room.
    zero integer 250
  Sets the cost to enter the Zero room.

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:

/tardisadmin 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.

Other admin commands

Enter a player’s TARDIS (by direct teleport instead of the door).

/tardisadmin enter [player]

Set the beacon block you are targeting in game, as a TARDIS recharge station.

/tardisadmin recharger [name]

Remove the specified beacon recharger from the config.

/tardisadmin decharge [name]

Set whether a specified world is included or excluded from random time travel destinations.

/tardisadmin include [world]
/tardisadmin exclude [world]

List all TARDISs and their locations.

/tardisadmin list

Remove a specified player’s TARDIS.

/tardisadmin delete [player]

List TARDISes that haven’t been used for an extended period.

/tardisadmin prunelist [number of days]

Remove TARDISes that haven’t been used for an extended period. See the Prune page for more details.

/tardisadmin prune [number of days]

Check or set a player’s TARDIS count.

/tardisadmin playercount [player]
/tardisadmin playercount [player] [count]

Delete a player’s TARDIS database records (will not remove any blocks in game).

/tardisadmin purge [player]

List chunks that are being kept loaded by TARDIS — either for room growing or Police Box locations.

/tardisadmin chunks

Chameleon Arch commands

See also the Chameleon Arch page.

View an ‘arched’ player’s real name.

/tardisadmin arch [player]

Force toggle a player’s ‘arched’ status.

/tardisadmin arch [player] force