Configuration

From FlashDevelop

Jump to: navigation, search

Contents

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>\Local Settings\Application Data\FlashDevelop
  • Windows Vista / 7: C:\Users\<username>\AppData\Local\FlashDevelop


Locating the configuration files

  • In FlashDevelop main menu, select Tools > Application 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\yourname\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\Generator.txt: code generator templates
    • \ASCompletion\FileCache: code completion cache, you can clean it up if it grows too much
    • \XmlCompletion\html.xml: HTML completion definition
    • \XmlCompletion\mxml.xml: MXML 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
    • \Languages\*.xml: languages syntax & colors configuration
    • \ScintillaNet.xml: global configuration of the syntax & colors
    • \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(*)
    • \FullScreen.fdb: (binary) panels organisation in fullscreen mode
    • \SessionData.fdb: (binary) files to reopen when starting FlashDevelop
    • \SettingsData.fdb: (binary) general application settings (delete to reset settings)
    • \LayoutData.fdb: (binary) panels organisation (delete to reset layout)
  • \Snippets: code snippets repository
  • \Templates: templates repository
    • \*.fdt general File > New... templates
    • \ProjectFiles: language specific templates for New... project files

(*) = 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): 
(default snippets list shortcut)
<button label="Label.Snippet" click="InsertSnippet" shortcut="Control|B" tag="null" flags="Enable:IsEditable" />

(add your snippets shortcuts)
<button label="Snippet name" click="InsertSnippet" shortcut="Control|Alt|B" tag="snippetname" flags="Enable:IsEditable" />


Editing Editor Coloring

You can edit the editor coloring from the XML files in "FD/Settings/Languages" directory and from "FD/Settings/ScintillaNET.xml" directly or with the Syntax Coloring dialog in FlashDevelop. If you are running in standalone mode you should edit the files in the application directory.


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.


ActionScript 3 configuration

Installing the SDK

Configuring the SDK:

Start FlashDevelop and go in the program settings,

  • Select "AS3Context" plugin and find the "Flex SDK Location" entry,
  • Enter the path to the SDK's root directory (ex: C:\path\to\flex3sdk).
  • Select "FlashViewer" plugin and find the "External Player Path" entry,
  • Enter the Flash Debug Player 10 path (ex: C:\path\to\flex3sdk\runtimes\player\10\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\flex3sdk\bin).

Automatic configuration of the SDK:

As of FlashDevelop RC3, FlashDevelop can do this configuration for you if you have not specifed the settings manually:

  • Move the Flex SDK into tools directory under FlashDevelop and rename it to "flexsdk". (ie: C:\Program Files\FlashDevelop\Tools\flexsdk)
  • Restart FlashDevelop. FlashDevelop looks for a included SDK and sets the settings if it can be found.

Troubleshotting the SDK:

If you see "INITIALIZING ?" in the Output panel when you try to build a project then you have a configuration problem.

  • Check your Java runtime (remove older versions or edit 'jvm.config' in the SDK's bin directory).
  • Some "clean" systems are missing a DLL: download msvcr71.dll and add it to: C:\Windows\System32

Project-specific SDK

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

  • Open the project properties,
  • Go to Compiler Options tab,
  • Fill the "Custom SDK Location" entry with an alternative SDK location.
Retrieved from "http://www.flashdevelop.org/wikidocs/index.php?title=Configuration"
Personal tools