Builder's Guide

This guide will walk you through the process of constructing Rooms and Widgets using Dungeonator's in-game editor.

Prerequisites

  • You must be an OP on the server in order to use the in-game editor.

Let's get to it!

Room Editor: Quick Start

Step 1: Start the Editor

First you need to activate a new instance of the editor. This can be accomplished with the /edit new command:

/edit new flatten:true hint:true fill:STONE

This command accepts three optional parameters:

  • flatten (boolean; default TRUE)
  • hint (boolean; default TRUE)
  • fill (string; default AIR)

Acceptable boolean values are true and false, or you can leave the parameter out to use the default.
Setting flatten to true will erase a total of 9 chunks (the current chunk and the 8 adjacent chunks) to prepare an empty area for the editor.
Setting hint to true will add door frames at the 12 compass directions to help you match your new room up with others. It will also add corner posts to show you the room's maximum height.
Setting fill will fill the room volume with the specified material, e.g. DIRT, MOSSY_COBBLESTONE, BRICK, etc.

Note: the Room Editor is initialized with a 1-block layer of cobblestone on the floor. This layer is part of the room.

Step 2: Build

Now you're ready to place some blocks. Any type of block is allowed.

Step 3: Add some Doorways

When you've finished placing blocks, you have one more task to take care of before saving your room. Dungeonator needs to know where you've placed your doorways in order to properly connect your room to others.
This is accomplished with the /edit doors command:

/edit doors reset:false add:n,e,nne,ssw remove:w,s

There's a lot to look at here, but it's not as complicated as it looks. This command will first reset (remove) all the doorways, then remove the South and West doorways, and finally add the north, east, northnortheast, and southsouthwest doorways.
The command accepts three optional parameters:

  • reset (boolean; default TRUE)
  • add (string list; default "")
  • remove (string list; default "")

Note: As with all of the edit commands, you can specify parameters in any order. The parameters will be executed in this order however: reset, remove, add.

Setting reset to true will remove ALL doorways from the current list.
The remove parameter takes a comma-separated list of compass directions.
The add parameter takes a comma-separated list of compass directions.

Note: Valid directions are: N,NNE,ENE,E,ESE,SSE,S,SSW,WSW,W,WNW,NNW,U,D. Long versions like up,north,southsouthwest are also accepted.

Any time you run this command, Dungeonator will print out a final list of doorways set for the room after all the operations have been completed. This also means that you can simply run /edit doors on its own to get a list of the current doorways.

Step 4: Save

Ok, you've built your room, added some meta data (doorways), and you're ready to save your progress. Enter the aptly-named /edit save command:

/edit save name:MyCoolRoom library:false

The command accepts two optional parameters:

  • name (string; default "UnnamedRoom-XXXXXXXX")
  • library (boolean; default FALSE)

The name parameter is fairly self-explanatory. Enter any filename you want, or leave this parameter out to use the default.
Setting the library parameter to true will add your finished room to the Dungeonator Library for use in generating new chunks.

Note: the /edit save and /edit load commands both accept a name parameter. On disk, your files will be stored with a .nbt file extension. You do not need to specify this extension when saving or loading; it will be added to the specified name automatically.

Done!

Congratulations! You've built your first room and added it to the library.

Widget Editor: Quick Start

TODO