# Welcome to the DictionaryForMIDs-Creator Documentation.

Below you will find a quick guide to the GUI components of DfM-Creator.

The picture below is a screen-shot of the the menu bar and the tabs. This is the GTK+ Look and Feel (on Ubuntu Linux 12.04). There are four tabs, each one represents one DictionaryForMIDs tool:

1. DictdToDictionaryForMIDs
2. DictionaryGeneration
3. BitmapFontGenerator
4. JarCreator

Above the tabs is the menu bar. Each menu and its items represent some of the options offered by the tab of the same name, i.e the JarCreator menu's items have the same name and functionality as the buttons on the JarCreator tab.

## The complete DictdToDictionaryForMIDs tab.

1. Database Name: This is where you put the name of the database (without the .ini extension).
2. Database Directory: This is the path to the directory containing the database files.
3. Output File Directory: This is the path to the location where the output file will be written to.
4. Encoding: Here you choose the encoding of the output file.
5. Choose a Separator Character: Here you choose the separator character for the output file.
6. Switch Languages: Choose if you want to switch the languages.
7. Keep Tab And New Line Chars: Choose here, if you would like to keep the tab and new line characters.
8. Remove Square Bracket Contents: Choose if you would like to keep the text within square brackets.
9. Clear Fields: Reset all the settings and delete the values entered.
10. Proceed: Proceed to the conversion process.

## The complete DictionaryGeneration tab.

1. Create: This takes you to the PropertiesEditor window which enables you to create a properties file.
2. Edit an Existing Properties File: This enables you to edit a properties file with PropertiesEditor.
3. Path to The Input CSV File: This is where you put the path to the input comma-separated-value (CSV) file.
4. Properties File's Directory: Put here, the location to the properties file's directory.
5. Destination Directory: This is the path to the destination directory.
6. Generate Dictionary Files: Click here to proceed to the dictionary generation process.
7. Clear Fields: Reset all the settings and delete the values entered.
8. Check an Existing CSV File's Integrity: This takes you to a window that will check a CSV file for errors.

## The complete BitmapFontGenerator tab.

1. Path to the Font File: Where the font file is located.
2. Path to the Dictionary: Where the dictionaryXXX.csv files' directory is located.
3. Font Size (Points): Choose a size here.
4. Clip Pixel From Top: choose a number here.
5. Clip Pixel From Bottom: choose a number here.
6. Generate Bitmap Fonts: Click here to proceed to the bitmap font generation.

## The complete JarCreator tab.

1. DictionaryForMIDs.properties and CSV files' Directory: Indicate the full path to the properties and CSV files.
2. Empty DictionaryForMIDs.jar/jad Files' Directory: Indicate the full path for the empty DfM.jar/jad Files
3. Output Directory: Put here, the path to the location of the directory that will hold the output file.
4. Pack "CSV" Files in the Empty DfM.jar File: Click here to proceed to the DictionaryForMIDs.jar/jad files creation
5. Create Jar/Jad Files: Reset all the settings and delete the values entered.

Table of Contents

1. Quick Tour

1. DictdToDictionaryForMIDs
2. DictionaryGeneration
3. BitmapFontGenerator
4. JarCreator

2. Complete Documentation

1. Important changes notes
2. Setting up a new dictionary
3. DictionaryForMIDs.properties file
4. DictionaryUpdate
5. DictionaryUpdate - Advanced
6. Normation - Available classes
7. Normation - Advanced
8. Multiple source dictionaries
9. Content declarations
10. Generation the Dictionary file
11. Creating DictionaryForMIDs.jar Manually

3. The DictionaryForMIDs-Creator Developer Documentation
   (links below point to various sections on the same page)

- Under the Hood
- Code overview
- Download Sources
- Build process