# 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 DfM-Creator tabs. This is the GTK+ Look and Feel (on Ubuntu Linux 13.04). There are four tabs, each one represents one DictionaryForMIDs tool:

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

## 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 CSV 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/Enqueue: Proceed to the conversion process or enqueue this one and come back to set another dict up for conversion.

## The complete DictionaryGeneration tab.

1. Create a Props File: 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. Input CSV File: This is where you put the input comma-separated-value (CSV) file.
4. DictionaryForMIDs.properties File: Put here, the properties file itself.
5. Output Directory: This is the path to the output directory.
6. Enqueue/Generate Dictionary Files: Click here to proceed to the dictionary generation process or to enqueue
   this dictionary and its settings and come back here to provide another dictionary along with its settings so as
   to have a queue of dictionaries to be generated.
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.
7. Clear Fields: Reset all the settings and delete the values entered.

## The complete JarCreator tab.

1. Input Dictionary: Indicate the full path to the DictionaryForMIDs.properties and CSV files' Directory.
2. Choose Your Own Empty DictionaryForMIDs Jar-Jad Files Indicate the full path the custom empty DictionaryForMIDs.jar/jad Files
3. Output Directory: Put here, the path to the location of the directory that will hold the output file.
4. Enqueue/Create Jar & Jad: Click here to proceed to the DictionaryForMIDs.jar/jad files creation or to enqueue
   this dictionary and its settings in order to come back here to enqueue another dictionary along with its settings
   so as to have a queue containing many dictionaries and JarCreator will process them all!
5. Clear Fields: 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