Dockable Window

These are all new for OpenRPG 1.7.0 And this page is here to explain a little about them. First of all there are four dockable windows, The Gametree, Map, Chat, and Players List windows, In addition to these the Dice Tool Bar and Status Tool Bar are now dockable.

This new system come with a default layout, but since the windows are all dockable you can visually create your own without needing to edit an xml file. (Note the default layout had the map window pined in place read the customization section for details). This new system also saves your window states and positions when you exit OpenRPG so there is no more need for the SaveWindow Plugin.

If you are having issue with your layout try deleting your layout.xml file and letting OpenRPG rebuilt the default one

Customization

There is a new file in your myfiles directory called layout.xml. This replaces the old gui.xml file. Its default content is

<orpg_gui height="731" maximized="1" posx="321" posy="56" width="1032"> 
    <tree height="150" width="300" caption="Gametree" direction="Left" name="tree" pos="1" />
    <player height="150" width="300" caption="Player List" direction="Left" name="player" pos="2"/>
    <map height="150" width="300" caption="Map Window" direction="Center" name="map" pos="0" />
    <chat height="400" width="300" caption="Chat Window" direction="Bottom" name="chat" pos="0" />
    <DockLayout DO_NOT_EDIT="True">GIBBERISH IN HERE</DockLayout>
</orpg_gui>

The first line tells the system the base height width position and if the window is maximized or not. This line gets updated evey time you close OpenRPG so there should be no need for you to edit it as it will load up the same way you had it when you exited.

The next four lines control the default layout of the four main windows. You can edit these if you wish. The two properties you may wish to edit are direction and pos. Direction specifies where the window will be docked by default and position specifies if where in the direction dock it is placed. NOTE If you edit this file you should delete the whole DockLayout section so the system can rebuild the layout. If you do not you may get unexpected results caused by the system trying to load an invalid layout.

Direction options are; Top, Right, Left, Bottom, or Center. Anything with the direction of Center becomes the default window for the main frame and thus is locked in place.

Pos can be any int, but usually will be either 0, 1 or 2

For the chat section the height and width are the chat windows MINIMUM height and width, so you may need to decrease these

The final line called DockLayout is an auto generated field that you should not edit. This is used by OpenRPG to save the window state and position so that they will open back up in the exact state and position they were in when you closed OpenRPG

Here is an example that uses tabs

<orpg_gui height="1136" maximized="1" posx="-4" posy="18" width="1600"> 
  <tab caption="Player Tree" direction="Left" height="150" pos="1" width="300">
    <tree caption="Gametree" direction="Left" height="150" name="tree" pos="1" width="300"/>
    <player caption="Player List" direction="Left" height="150" name="player" pos="2" width="300"/>
  </tab>
  <map caption="Map Window" direction="Center" height="150" name="map" pos="0" width="300"/>
  <chat caption="Chat Window" direction="Bottom" height="150" name="chat" pos="0" width="300"/>
</orpg_gui>

Which looks roughly like