/Freeplane_KeyMap_for_Carnac

Groovy script to create an yml file containing the actual key shortcuts of Freeplane to be used with Carnac

Primary LanguageGroovyGNU General Public License v3.0GPL-3.0


Freeplane_KeyMap_for_Carnac

Groovy script to create an yml file containing the actual key shortcuts of Freeplane to be used with Carnac

Carnac helps showing the keystrokes the user make when using an application. This can be helpful when doing HowTo videos or streaming.

Look a few seconds of this video to get the idea of how it works with Freeplane.


1. About Freeplane_KeyMap_for_Carnac

The script in this repository takes the information about the key accelerators that are active in your Freeplane application and save them as an .yml file that can be used by Carnac.

The file is saved in the same folder where the script is.

In the same folder must the keysDict.txt file be copied. It is used by the script to translate some keys from the Freeplane denomination to Carnac's one.

The information read by the script is the same you can see in Freeplane in the "Hot keys table" that you can access through Help/Key Reference menu command. This table contains standard and custom key combinations.

This new file (Freeplane.yml) has to be then manually copied to the Carnac\Keymaps directory.

(usually in C:\Users\xxx\AppData\Local\carnac\Keymaps)

The Freeplane.yml file that is in this repository was made using this script by me, so, it contains the key combination I personally use in Freeplane.


2. Motivation

I wanted to do some videos about using some Freeplane features and came to Carnac as an option to show the KeyStrokes I use while using Freeplane.

What I liked about Carnac was that it also shows which action the keystroke is calling (Maybe there are better applications for this but I didn't look any further).

I made this as a script because key combinations in Freeplane can easily be changed and can be very different between different users, so it helps to be able to update the Carnac yml file easily.

I'm learning how to do scripts in Groovy for Freeplane and it also seamed as a nice challenge to excercise with.

I think it's a script that can be easily adapted for other applications (if needed)

Look at the script itself for further information. I put a lot of comments to make it understandable.


3. About Freeplane

Freeplane is a free and open source software application that supports thinking, sharing information and getting things done at work, in school and at home. The software can be used for mind mapping and analyzing the information contained in mind maps. Freeplane runs on any operating system that has a current version of Java installed. It can be run locally or portably from removable storage like a USB drive.

Freeplane example


4. About Carnac - 'the Magnificent Keyboard Utility'

Carnac is a keyboard logging and presentation utility for presentations, screencasts, and to help you become a better keyboard user. (As far as I know it is Windows only)

Carnac in code52.org

Carnac in GitHub

Carnac screenshot

Carnac example