Configuration

Table of Contents Configuration files Locating the configuration files User files organization Editing menu items Editing snippets Editing templates Editing syntax coloring Configuring the Flex SDK Manual configuration of the Flex SDK Project-specific Flex SDK

Configuration files

By default, FlashDevelop supports multiple users on a machine (except if you install in "standalone mode"). This means user configuration is stored in user files. You can can safely remove the FlashDevelop directory in your user files. These files will be restored when you restart FlashDevelop.

User files location depends on your OS: Windows XP: C:\Document and Settings\<username></username>\Local Settings\Application Data\FlashDevelop Windows Vista / 7 / 8: C:\Users\<username></username>\AppData\Local\FlashDevelop

Locating the configuration files

• In FlashDevelop main menu, select Tools > User Config Files...
• This will open a Window Explorer in the correct location on your computer.

Tip - Some setting files are not copied into your user files In this case, you can copy an existing setting file: from: C:\Program Files\FlashDevelop to: C:\Document and Settings\<username></username>\Local Settings\Application Data\FlashDevelop Just follow the way files are organized, FD will pick the user version if it exists.

User files organization

The user files contain the following contents:

• \Data: plugins configuration storage, delete this directory to reset all/some plugins settings.
  • \ASCompletion\FileCache: code completion cache, you can safely clean it up
  • \XmlCompletion\html.xml: HTML completion definition
• \Plugins: user's own 3rd party plugins
• \Projects: user's own project templates
• \Settings: general application configuration
  • \Recovery: saved temporary recovery files
  • \FileStates: file state config files
  • \FormStates: smart dialog config files
  • \Languages\*.xml: languages syntax & colors configuration
  • \Themes\*.fdi: UI Theme files and full and syntax themes in sub dirs
  • \MainMenu.xml: main menu items definition(*)
  • \ToolBar.xml: main toolbar items definition(*)
  • \ScintillaMenu.xml: editor's context menu items definition(*)
  • \TabMenu.xml: documents tabs' context menu items definition(*)
  • \LayoutData.fdl: (xml) panels organisation (delete to reset layout)
  • \SessionData.fdb: (binary) files to reopen when starting FlashDevelop
  • \SettingData.fdb: (binary) general application settings (delete to reset settings)
  • \ShortcutData.fda: (binary) user specified shortcuts
  • \UserArgData.fda: (binary) user specified arguments
• \Snippets: code snippets repository
• \Templates: templates repository
  • \ProjectFiles: language specific templates for New... project files
  • \*.fdt general File > New... templates
  • \*.fdt.wizard class wizard templates

(*) = If you customize the files you should place them here. They can be found from the "FD/Settings" directory.

Editing menu items

You can edit all main menu and context menu items from the XML files in the "FD/Settings/" directory. When you change these files you should place the customized files to the "Setting" directory under user application data directory. If you are running in standalone mode you should edit the files in the application directory.

Tip - Adding shortcuts to user snippets Create a snippet as usual, using the Snippet Editor (shortcut in main toolbar) Add a shortcut in your MainMenu.xml (you'll want to duplicate it in your user files): (add your snippets shortcuts) &amp&#59;lt&#59&#59;button label&#61&#59;&amp&#59;quot&#59&#59;Snippet name&amp&#59;quot&#59&#59; click&#61&#59;&amp&#59;quot&#59&#59;InsertSnippet&amp&#59;quot&#59&#59; shortcut&#61&#59;&amp&#59;quot&#59&#59;Control&amp&#59;&#35&#59;124&#59&#59;Alt&amp&#59;&#35&#59;124&#59&#59;B&amp&#59;quot&#59&#59; tag&#61&#59;&amp&#59;quot&#59&#59;snippetname&amp&#59;quot&#59&#59; flags&#61&#59;&amp&#59;quot&#59&#59;Enable&#58&#59;IsEditable&amp&#59;quot&#59&#59;&amp&#59;gt&#59&#59;&amp&#59;lt&#59&#59;/button&amp&#59;gt&#59&#59;

Editing snippets

The user snippet files are located in the application data directory and you can edit them directly in there or use the Code Snippet dialog in FlashDevelop. If you are running in standalone mode you should edit the files in the application directory.

Editing templates

The user templates are located in the application data directory and you can edit them directly from there. If you are running in standalone mode you should edit the files in the application directory.

Editing syntax coloring

You should edit the syntax coloring from the Syntax Coloring dialog from Tools->Syntax Coloring...

Syntax files are located in /Settings/Languages/. Each syntax file indicates:

• Lexer to use (ie. cpp for AS/JS/etc, html, python, ...),
• Associated file extensions (ie. html/php/aspx/etc. are all html),
• Styles entries and number of keyword classes are fixed by the lexer; the best way to find out how many classes are supported is to look into an existing SciTE syntax file.

Supported lexers and style names are defined in FD sourcecode: http://code.google.com/p/flashdevelop/source/browse/trunk/FD4/PluginCore/ScintillaNet/Lexers.cs

Configuring the Flex SDK

FlashDevelop will configure the installer downloaded tools automaticly on the next startup.

Manual configuration of the Flex SDK

Once you've downloaded the Flex SDK, unzip it in a user directory (ie. not under Program Files).

Start FlashDevelop and go in the program settings,

• Select "AS3Context" plugin and find the "Installed SDKs" entry,
• Create a new SDK entry and locate the Flex SDK's root directory (ie. C:\path\to\flexsdk) - SDK version should be detected automatically.
• Select "FlashViewer" plugin and find the "External Player Path" entry,
• Enter the Flash Debug Player path (ie. C:\path\to\flexsdk\runtimes\player\10.1\win\FlashPlayer.exe).

Then in FlashDevelop go to Tools -> Flash Tools -> Documentation Generator -> Settings

• Enter the asdoc.exe path to the ASDoc location (ie: C:\path\to\flexsdk\bin).

Project-specific Flex SDK

For some projects you may want to use a specific Flex SDK version:

• Open the project properties,
• Go to SDK tab,
• Select alternative SDK path from the list of SDKs.