I've started working on a collection of syntax highlighting modules for Fabric Engine's KL language. At the moment there are modules for Notepad++, TextWrangler, and BBEdit. This page will be updated as more text editors are supported.
The Fabric Engine KL Syntax Highlighter module is a free download.
You can download the latest version here:
Fabric_Engine_KL_Syntax_Highlighter.zip (2 MB)
There is a repository on GitHub too.
Notepad++ Fabric Engine KL Syntax Highlighter
Version 1 Released March 12, 2013
by Andrew Hazelden
I would like to present a new Notepad++ syntax highlighting module that works with code from Fabric Engine's KL language. The new module makes it easier for a VFX Artist or Technical Director to edit a KL script.
Note: The free program Notepad++ is required to use the syntax highlighter.
Step 1. Download Notepad++ and install it on your system. After you start Notepad++ you will see a blank text editing window.
Step 2. The syntax highlighting module has been customized to work with the dark background based Obsidian theme. To load the Obsidian theme in Notepad++, go to the Settings menu and select "Style Configurator..."
In the Style Configurator window select the Obsidian theme and click the Save and Close button.
Step 3. Let's load the custom "Fabric KL" syntax highlighting module. Open the Language menu in Notepad++ and select the "Define your language..." menu item. The User Defined Language window will load.
Step 4. In the User Defined Language window, click on the Import button to load the XML based language file.
In the open dialog select the "userDefine_FabricEngineKL v1.xml" file and click open.
If the file was loaded correctly an "Import Successful" notice will appear. Click the OK button to continue. At this point you should close the "User Defined Language" widow by clicking on the window's X shaped close button.
Step 5. We need to restart Notepad++ for the new language module to be listed in the Notepad++ language menu.
If you open a Fabric Engine .kl script at this point you will see formatted text. If you are working on an script file without the .kl extension you can select the language manually.
Open the Language menu and select Fabric KL. This will turn on syntax highlighting and make it easier to develop complex include files.
Here is an example Fabric Engine .kl script called "swirleyMovementOp.kl" with Notepad++ based syntax highlighting enabled:
BBEdit and TextWrangler Fabric Engine KL Codeless Language Module
Version 1 Released March 14, 2014
by Andrew Hazelden
I would like to present a new BBEdit and TextWrangler syntax highlighting module that works with code from Fabric Engine's KL language. The new module makes it easier for a VFX Artist or Technical Director to edit a KL script.
Note: This syntax highlighting module requires either TextWrangler (free) or BBEdit from Bare Bones Software.
Step 1. Download TextWrangler and install it on your system. If you own a copy of BBEdit you can use it instead. After you install the software, run it once to create the preference folders.
Step 2. Copy the "Fabric Engine KL.plist" file from the install folder to your Language Modules folder.
If you are using TextWrangler the module belongs in this folder:
~/Library/Application Support/TextWrangler/Language Modules/
If you are using BBEdit the module belongs in this folder:
~/Library/Application Support/BBEdit/Language Modules/
On Mac OS X Lion / Mountain Lion you can open the hidden ~/Library folder by switching to the Finder. From the "Go" Menu select, "Go to Folder..." or press the hotkey Shift-Command-G.
Paste in the Languages Module folder path and hit "go".
If you are running Mountain Lion and the BBEdit / TextWrangler "Language Modules" folder doesn't exist you can create the folders manually. A quick way to create the folders is to use the terminal:
TextWrangler Folder Creation Command:
mkdir -p ~/"Library/Application Support/TextWrangler/Language Modules/"
BBEdit Folder Creation Command:
mkdir -p ~/"Library/Application Support/BBEdit/Language Modules/"
Once you are in the Language Modules folder you can copy the Fabric Engine KL.plist file in place.
Step 3. We need to restart TextWrangler for the new language module to be listed in the TextWrangler language popup menu.
If you open a Fabric Engine .kl script at this point you will see formatted text. If you are working on an Fabric Engine file without the .kl extension you can select the language manually.
Open the Language popup menu at the bottom left of the text editor window and select Fabric KL. This will turn on syntax highlighting.
Here is an example Fabric Engine .kl script with syntax highlighting enabled:
Bonus - Download a Color Scheme
If you are new to TextWrangler or BBEdit you will probably want to download a color scheme to customize your work environment. I've written two themes to get you started: The Charcoal Color Scheme and the Midnight Blue Color Scheme.
This is the view with the default color scheme that comes with TextWrangler / BBEdit:
This is the view with the Charcoal Color Scheme in action:
This is the view with the Midnight Blue Color Scheme in action: