Commands

catacombs

   /catacombs

Lists the commands in game. The main command used to access all other commands.

cat

   /cat

A shorter alias for /catacombs intended for general use.

plan

   /cat plan <name> <depth>
   /cat plan <name> <depth> <radius>

This command is used to test a possible location for a dungeon and let you know if it's a good location to build.

The Hut

The block you are standing on when you plan will become the middle of a "Hut" when the dungeon is eventually built, so make sure there is enough space around you. No checks are made that the above ground area around you is empty so don't plan near anything you value. The direction you are facing when you plan is also significant. The door to the safe house will be behind where you were.

Stairs

It checks there is a vertical shaft of solid-natural material starting two blocks beneath your feet and going down to the bottom of the first level (9 blocks is the default depth on the config). By default natural is defined as stone,dirt,sand,gravel, sandstone and the natural ores. Note grass isn't on the list, but this is usually fine because the planner ignores the block you are standing on and starts checking below that. All other blocks (air, water, cobble etc. etc.) will act as boundary limits for the dungeon and will not be damaged (the only exception to this is for the above ground hut that will be built over any existing structures if you plan too close). Which blocks are considered natural can be customize in the config.yml file (to allow building through air or Netherrack for example).

Level

Once it's established there is room for the shaft down it will check if there is enough space for one dungeon level. It will start looking North, South, East and West from the stairs checking how much solid-natural space it can find, this will continue up to a maximum "radius" that's given in the configuration file (or supplied as a <radius> on the command line). The "radius" is measured in all directions from each stair down so a "radius" of 10 will limit each level size to a maximum square region of 21x21 (10+1+10=21). Each level may be less than this maximum size if there isn't enough solid-natural space to build into, but not more. Note that because each level is built from the stairs down the dungeon levels don't have to (and often won't) stack up neatly above each other.

Deeper

If you plan a dungeon <depth> that is one deep you'll get a hut and one underground level of dungeon. If you ask for more levels the process listed above will be repeated until the number of levels is met (or you run into bedrock). If there isn't enough space for a given level or shaft down or if the dungeon is very full and it can't find a location for a stair structure (3x2) then the plan will fail and the dungeon can't be built. Very deep dungeons will always fail because they'll run into bedrock and be incomplete. Dungeons with a very small radius will almost always be incomplete too because there won't be valid locations for the stairs up and down.

After a successful plan, you'll get a message in game listing the size and number of rooms of every level like this:

   > /cat plan N 2 8
   Area (7x7) rooms=1
   Area (17x17) rooms=11
   Area (17x17) rooms=10
   'N' is good and ready to be built

Planned dungeons (that haven't been built) are forgotten when the server is restarted. Dungeons that have been built will not be lost when the server is restarted.

Map

There currently is no in game map facility but all the details of the planned levels are sent to the server console and the plugins/Catacombs/maps directory. See below (the key is here: Square.java)

unplan

   /cat unplan <name>

This command is rarely needed. It can be used to forget about a dungeon that is planned but hasn't been built. It can be useful when two unbuilt dungeons overlap each other (this usually prevents them being built).

build

   /cat build <name>

You must plan a dungeon before you build it. This command converts a successful dungeon plan into Minecraft blocks. The build command takes just one parameter, the name of the dungeon you planned earlier. All the important details were given or locked in during the planning step (location, direction, depth, radius, name etc.).

It's wise to stand well away from the planning location when building a dungeon so that you don't get embedded in a wall of the Hut.

Planned dungeons (that haven't been built) are forgotten when the server is restarted. Dungeons that have been built will not be lost when the server is restarted.

scatter

   /cat scatter <name> <depth> <radius> <distance>

The scatter command is similar to the plan and build commands combined and can be used to drop a dungeon at a random location some way from your current location. The <name>, <depth> and <radius> arguments are all identical to the ones for a 'plan' (see above). The final <distance> operand is the maximum distance in blocks from your current location of the new dungeon entrance. As with the radius operand for the plan command itself, a "distance" of 1000 means the dungeon entrance will be no more than 1000 blocks north, south, east or west of the current location (if you like it's the "radius" of a square, and although this is nonsense, it's in keeping with the spirit of minecraft where circles are squares). The scatter command will try and plan and build a dungeon several times (30) before giving up so it often will find a suitable location.

time

   /cat time <time>
   /cat time <name> <time>

The command changes the reset timer for the named dungeon (or the dungeon you are in). The time periods are specified as sequence of numbers followed by letters (s=second, m=minute,h=hour,d=day). For example '/cat time dungeon1 5h30m' means dungeon1 will be reset every 5 and a half hours (starting from now). The time can also be a range, so 5h30m-6h30m would set the dungeon up to reset every 5.5 to 6.5 hours. The automatic reset is disabled by setting the reset time to zero (i.e 0s or 0m or 0h or 0d). Players within the dungeon will get a sequence of warnings starting at 5 minutes counting down to the reset when they'll be kicked out (back to the entrance).

when

   /cat when
   /cat when<name>

Let's you know when a timed reset will occur for the named dungeon (or the dungeon you are in or the dungeon you are looking at) (see the /cat time command for more details of the returned time format).

delete

   /cat delete <name>

Fill the dungeon in with plain stone and remove protection. Any players in the Dungeon are teleported up into the Hut before the levels are filled in. Once it's deleted it's gone.

reset

   /cat reset <name>
   /cat reset

Reset a dungeon back to an initial state. Kick out any players, remove all the monsters, close all doors, remove torches, refill chests. If no dungeon name is given it defaults to the dungeon you are standing in. Limitation: webs, mushrooms and spawners are not rebuilt at present, so surround spawners with torches rather than destroying them as a work around.

resetall

   /cat resetall

The same as /cat reset but it resets all the dungeons across all worlds.

unprot

   /cat unprot <name>

Leave the dungeon structure as it is, remove all protection and forget about the dungeon. Once it's unprotected it's gone.

suspend

   /cat suspend <name>
   /cat suspend

Turns the lights on, stops monsters spawning and disables the protection in the named dungeon so that you can make changes before re-enabling. If no dungeon name is given it defaults to the dungeon you are standing in.

enable

   /cat enable <name>
   /cat enable

The opposite of suspend command. If no dungeon name is given it defaults to the dungeon you are standing in.

recall

   /cat recall

Word of Recall. This command teleports you to the top of the dungeon if you are close (within 4 blocks) of the end of dungeon chest on the final (bottom) level. This command is intended for players.

goto

   /cat goto <name>
   /cat goto

This command teleports you to the top of the named dungeon. This command is intended for Admin. If no dungeon name is given it defaults to the dungeon you are standing in.

end

   /cat end <name>
   /cat end

This command teleports you to the final chest of the named dungeon. This command is intended for Admin. If no dungeon name is given it defaults to the dungeon you are standing in.

which

   /cat which
   /cat ?

Tells you the name of the dungeon you are standing in. If the dungeon has been unprotected then this command will tell you you aren't in a dungeon. If you are not in a dungeon it will tell you the name of the dungeon you are looking at (if any).

style

   /cat style          
   /cat style <style>

Tells you the name of the dungeon style you are building in. Sets the dungeon style if one is given on the command line. Use '/style <name>' to change to the dungeon planner/loot gen to a different style. For example if you carefully add the lines below to your config.yml and then '/cat style grand' the values below will override the default 'catacomb' values where they both exist. Notice even the loot can be customized. Changing styles before calling '/cat reset <dungeon>' is handy if you want to define several of your own custom loot lists to refill chests with. Limitation: Be warned the style is server wide and resets to 'catacomb' when you log at present.

grand:
    Archway:
        DoubleWidthPct: 100
    Depth:
        room: 4
    Corridor:
        Width3Pct: 20
        Width2Pct: 80
        Max: 15
        Min: 6
    Room:
        Max: 20
        Min: 8
        Clutter:
            ChestPct: 50
    CorridorPct: 20
    RadiusMax: 40
    Loot:
        Medium:
            List:
            - torch:100:32

list

   /cat list

List the names of all the recognised dungeons in game (in alphabetical order).

gold

   /cat gold

How much do you have from killing mobs

iron

   /cat iron
   /cat iron <name>

Changes all the wooden doors to iron either in the dungeon you are in or in the named dungeon.

ironall

   /cat ironall

Changes all the wooden doors to iron in all the dungeons.