DipTool 2.7.1 Documentation

Contents

Introduction
Entering Orders
The Menu Bar
The Preferences
The Tool Bar
The Tree
Groups
Games
Turns
Press Messages
E-Mail Accounts
Add-Ins

Introduction

DipTool parses the output of the diplomacy judges (results, lists, histories, summaries, and press messages) and history files of Keith Schneider. It then adds the games, turns, and messages to the tree and displays the maps. You can enter the orders using Drag & Drop or popup menus and send the orders to the judges. DipTool also has a build in adjudicator so that you can use it during a FTF game.

Let's start with discussing the biggest problem: how do you get the e-mail messages from the judges into DipTool? There are several possibilities:

Entering Orders

There are two ways to enter orders: Using Drag & Drop you can fast enter the most common orders and using popup menus you can enter all possible orders. You can only enter orders for the current turn and only if you are in the order-editing mode (simply press Edit Orders in the tool bar).

You can always copy the entered orders to the clipboard and paste them in your e-mail program to send them to the judge. If you want to directly send them via SMTP to the judge you must create an e-mail account and select it in the game properties.

Drag & Drop

You can drag a unit on the map with the left mouse button. If you want to drag a unit it is sufficient to start the drag somewhere in the province of the unit. While you drag a unit you can see on the map and in the status bar the result of a drop.

Note: If a province has multiple coasts (like St Petersburg) it can make a difference where you drop the unit over the province.

Note: To enter a move via a convoy with route (e.g. A Edi-NWG-Nor) you must use the popup menus (s. below).

If you drag a dislodged unit in a retreat phase from the province where it was dislodged (although it is invisible there) to another province then the result is a retreat order. If you drop the unit over the same province then the result is a disband order.

In an adjustment phase you can build and remove units by simply clicking into the corresponding province. If it is possible to build an army or a fleet then an army is build. If you click again into the same province a fleet is build instead of the army. If a province has multiple coasts (like St Petersburg) you can choose between an army and the different coasts by the position where you click into the province.

Popup Menus

You open the popup menu by clicking the right mouse button over a unit (it is sufficient to click over the province of the unit). You select the type of the order in the popup menu. The available types depend on the possible orders. A few examples:

Army Order Menu Fleet Order Menu

Retreat Order Menu Build Order Menu Remove Order Menu

If further provinces are necessary for the order you can select them by clicking the left mouse button over them. While you enter the order you can see in the status bar the already completed part of the order and the next possible provinces are highlighted on the map.

The Menu Bar

The File Menu

File Menu

The Help Menu

Help Menu

For the other menus s. E-mail Account, Group, Game, and Turn. They are only available if such a node (or a child of such a node) is selected in the tree.

The Preferences

Preferences Dialog

Judge Dialog

The Tool Bar

Tool Bar

New New: Creates a new empty DipTool file.
Open Open...: Opens an existing DipTool file (.dtf). If the file contains e-mail accounts where Check automatically for new messages is selected then the e-mail messages are received from these accounts and stored on the hard disk. If the file contains groups where Scan automatically for new files is selected then the specified files and all files that are contained in the specified directories and all sub directories (recursively) are looked at. The new or changed files are parsed. The collected information is added to the tree (e.g. new games or turns).
Save Save: Saves the current DipTool file (.dtf).
Abbreviations Show province abbreviations: If this toggle button is selected then the province abbreviations (e.g. Ber for Berlin) are shown on the map.
Centers Show center ownership: If this toggle button is selected and a province contains a center then the background color of the province on the map shows the owner of the center.
Units Show units: If this toggle button is selected then the units are shown on the map.
Orders Type Show orders (color in accordance with type): If this toggle button is selected then the orders are shown on the map (red: moves, green: supports, blue: convoys). If an order wasn't successful (e.g. a support was cut) then the color is darker.
Orders Power Show orders (color in accordance with power): If this toggle button is selected then the orders are shown on the map. The color shows which power gave the order (if there are no proxy orders this is the owner of the unit). If an order wasn't successful (e.g. a support was cut) then the color is darker.
Edit Orders Edit orders: Turns on/off the order-editing mode. You can only enter orders for the current turn of a game.
Zoom Map Show only the map: The tree and the orders area are hidden so that there is more space for the map.

The Tree

The root of the tree is always the text "DipTool". The root can have groups and e-mail accounts as children. Groups can have games, games can have turns, and turns can have press messages as children.

If you click the right mouse button over the root of the tree the following popup menu is shown.

Root Popup Menu

The menu items are a subset of the File menu and described there.

Group Groups

A group is a collection of games (e.g. all games you are currently playing). You can create a new group by selecting New Group... in the File menu. For a group some files and directories can be specified. If one of the specified files or a file that is contained in one of the specified directories or a sub directory (recursively) of such a directory is new or changed then it is parsed and the information in the file is added to the tree (e.g. new games or turns).

If you click the right mouse button over a group in the tree or select Group in the menu bar the following menu is shown.

Group Menu

Group Properties Dialog

Game Games

A game consists of turns and press messages. If you select a game in the tree the map of the current turn (the last one in the tree) is shown. Below the map the information about the turn and the game is displayed. The icon shows the state of the orders for a game.

Game If you have more than 8 hours to enter the orders, the deadline of the current turn is unknown, or you are neither a player nor the master of the game.
Game (no orders necessary) If no orders are necessary because the game is over, you are the master, or you need not enter orders (e.g. in a retreat phase).
Game (warning) If you must enter orders within the next 8 hours.
Game (late) If you are late or you are the master and a player is late.
Game (orders sent) If you already copied orders to the clipboard or sent orders to the judge.

If you click the right mouse button over a game in the tree or select Game in the menu bar the following menu is shown.

Game Menu

Game Properties Dialog

Turn Turns

If you select a turn in the tree the map of the turn is shown. Below the map the information about the turn is displayed. If some information about the turn is missing the turn icon has a red border Turn (incomplete)

If you click the right mouse button over a turn in the tree or select Turn in the menu bar the following menu is shown.

Turn Menu

Below these menu items the available turn menu add-ins are shown (at the moment it exists no standard turn menu add-in).

The following dialog is shown before the orders are copied to the clipboard or sent to the judge.
Note: This dialog is not modal. Thus you can e.g. open multiple dialogs simultaneously or view other turns while the dialog is open.

Orders Dialog

Message Press Messages

If you select a press message in the tree the map of the corresponding turn is shown. Below the map the message is displayed. There are four icons for press messages.

Message Partial press messages with exactly one recipient.
Two Messages Partial press messages with more than one recipient.
Broadcast Message Broadcast messages.
Diary Entry Diary entry.

You can filter the messages that are shown in the tree by selecting Filter Messages... in the game popup menu. You can set different filters for different games. Only the messages that match the filter are shown in the tree. A message matches the filter if all criteria are fulfilled, i.e. if one criterion is not fulfilled the message is hidden. By default (s. the image below) all messages are shown.
Note: The message filters are not saved in the DipTool files (.dtf). So if you open a DipTool file there are always no filters and all messages are shown.

Message Filter Dialog

E-mail Account E-Mail Accounts

DipTool can get e-mail messages from POP3 and IMAP accounts. You can create a new e-mail account by selecting New E-Mail Account... in the File menu. You can use one or more e-mail accounts to automatically store the e-mails from the judges on the hard disk. Only if the e-mail messages are stored in a directory or a sub directory (recursively) of a directory that is specified in a group they are parsed and the collected information is added to the tree (e.g. new games or turns). The easiest way to achieve this is to add the Base directory of the e-mail account to the Directories and files to scan of a group. Alternatively you can add the game sub directories to the Directories and files to scan of different groups if you want to add the games to different groups (e.g. one group for full press games and one for no-press games).

DipTool can send your orders directly to the judges using SMTP. The e-mail account that you use to send your orders to the judge should be the same as the one that you normally use to send e-mails to the judge. The settings on the tab "Get messages" are independent of the settings on the tab "Send message". So you can enter the data of different e-mail accounts on the two tabs. But I recommend that you create two e-mail accounts in this case.

If you click the right mouse button over an e-mail account in the tree or select E-mail Account in the menu bar the following menu is shown.

E-mail Account Menu

E-mail Account Properties Dialog

E-mail Account Properties Dialog

Add-Ins

At the moment only menu add-ins are supported. The existing add-ins are listed in "addins/AddIns.xml" (s. AddIns.dtd). If an add-in menu item is selected the constructor of the add-in is executed:

public Classname(javax.swing.JFrame parent,
                 de.hagenah.diplomacy.diptool.Preferences preferences,
                 Object obj)
                 throws Exception

parent - A parent frame for dialog boxes
preferences - The preferences of the user
obj - The selected object in the tree:

The constructor should not return before the add-in has finished. It is executed by the event dispatching thread.
Note: This is the add-in interface of DipTool v2.0. The old interface of DipTool v1.0 is still supported.

This is the source code of the opening statistic add-in and the test add-in.

The Observer Add-In

This add-in is from Matthias Wuttke. It gets a history and a list/summary of a game from Alain Tésios online mapper www.floc.net. The game is added to the selected group or if an already existing game is selected it is updated (only the necessary part of the history is retrieved). There must be an Internet connection and the game must be registered with the www.floc.net observer.
Note: The broadcast messages (e.g. EOG's) are not in the histories of the www.floc.net observer.

You can import a game by selecting "Import Game from www.floc.net Observer..." in the group popup menu.

Observer Add-In Dialog

If there are new results you can update the game by selecting "Update Game from www.floc.net Observer" in the game popup menu.

The Opening Statistic Add-In

This add-in calculates a simple opening statistic for all groups or one group.

The Test Add-In

This add-in tests all groups, a group, or a game. If all necessary information is present then the turns are adjudicated and the result is compared with the original adjudication. If some information is missing it is determined which information is missing.

The Web Add-In

This add-in creates a web site for all groups, a group, or a game.

Web Add-In Dialog