small corrections
+55 −50 · 1 file changed
-
default.cfg+55 −50
@@ -1,44 +1,49 @@ // KD100 config file // -// Assumptions: -// - (B)utton defines a new button and the following number specifies which button it is. -// - (B)uttons do not need to be listed in order but their type and function must be listed on separate lines afterwards. -// - (B)utton definitions can be skipped if you don't want all the buttons to work on the keydial. -// - (B)utton, type, and function definitions can contain numbers, symbols, or letters before hand but must have a number or function after the ':' -// - Ex) @#$!123ttype: 1 - is valid -// - type: f02r - will default to type 0 -// - type and function definitions must be lower case but can be in any order -// - The program defaults the type to 0 and the function to null -// - The (W)heel works in two parts. The first definition assigns all functions for turning it clockwise while the second definition assigns counter clockwise functions -// - The wheel functions must be defined at the end of the config file -// - If one wheel side has more functions than the other, it will set the function of the other wheel to NULL and do nothing when turning the wheel that way -// - Three wheel functions are provided but there is no limit to the amount you can add -// - Both button and wheel definitions do not read '//' before them and the wheel definition do not need the text after it to work -// - '//' is not required to add comments to the file but anything after a button, type, or function will be included in the program -// - All other text is skipped by the program -// - (W)heel functions cannot run programs or act as mouse input -// -// (B)utton Types: -// 0: Key - The pressed button acts as a key or a combination of keys -// ex) a = key 'A' | ctrl+a = control and 'A' at the same time -// 1: function - The pressed button runs a bash command/script -// ex) krita | echo Hello world | gpio www.example.com -// NOTE: "swap" changes the wheel buttons function -// 2: Mouse buttons - Specify mouse1, 2, 3, 4, or 5 activates mouse buttons (left/middle/right/scroll up/ scroll down) -// ex) type: 2 function: mouse1 +// Assumptions: +// - (B)utton defines a new button and the following number specifies which button it is. +// - (B)uttons do not need to be listed in order but their type and function must be listed on separate lines afterwards. +// - (B)utton definitions can be skipped if you don't want all the buttons to work on the keydial. +// - (B)utton, type, and function definitions can contain numbers, symbols, or letters before hand but must have a number or function after the ':' +// - Ex) @#$!123ttype: 1 - is valid +// - type: f02r - will default to type 0 +// - type and function definitions must be lower case but can be in any order +// - The program defaults the type to 0 and the function to null +// - The (W)heel works in two parts. The first definition assigns all functions for turning it clockwise while the second definition assigns counter clockwise functions +// - The wheel functions must be defined at the end of the config file +// - If one wheel side has more functions than the other, it will set the function of the other wheel to NULL and do nothing when turning the wheel that way +// - Three wheel functions are provided but there is no limit to the amount you can add +// - Both button and wheel definitions do not read '//' before them and the wheel definition do not need the text after it to work +// - '//' is not required to add comments to the file but anything after a button, type, or function will be included in the program +// - All other text is skipped by the program +// - (W)heel functions cannot run programs or act as mouse input +// +// (B)utton Types: +// 0: Key - The pressed button acts as a key or a combination of keys +// ex) a = key 'A' | ctrl+a = control and 'A' at the same time +// 1: function - The pressed button runs a bash command/script +// ex) krita | echo Hello world | gpio www.example.com +// NOTE: "swap" changes the wheel buttons function +// 2: Mouse buttons - Specify mouse1, 2, 3, 4, or 5 activates mouse buttons (left/middle/right/scroll up/ scroll down) +// ex) type: 2 function: mouse1 // -// Each key is numbered from the top left to the bottom right and keeps the wheel and button separate. The wheel button is button 18 -// |---------------| -// | 0 | 1 | 2 | 3 | -// |---|---|---|---| -// | 4 | 5 | 6 | 7 | -// |---|---|---|---| -// | 8 | 9 | 10| 11| -// |---|---|---|---| -// | 12| 13| 14| | -// |-------|---| 15| -// | 16 | 17| | -// |---------------| +// Each key is numbered from the top left to the bottom right and keeps the wheel and button separate. The wheel button is button 18 +// +// +---------------+ +// | .---. | +// | ( 18 ) HUION | +// | '---' | +// |---------------| +// | 0 | 1 | 2 | 3 | +// |---|---|---|---| +// | 4 | 5 | 6 | 7 | +// |---|---|---|---| +// | 8 | 9 | 10| 11| +// |---|---|---|---| +// | 12| 13| 14| | +// |-------|---| 15| +// | 16 | 17| | +// +---------------+ // // @@ -49,21 +54,21 @@ // Leader Timeout: Ammount of time that leader remains active in miliseconds. // Leader Mode: One of the three modes that the leader will act. // -// One shot: The leader keypress will act one time in the configured time window. +// One shot: The leader keypress will act one time in the configured time window. // Example: Press Button 16 (leader) -> Press Button 0 (b) -> Result: shift+b -> Leader resets // -// Sticky: Leader stays active until timeout -// Example: Press Button 16 (leader) -> Press Button 0 (b) -> Result: shift+b -// Press Button 1 (p) -> Result: shift+p -// Press Button 2 (t) -> Result: shift+t -// Timeout after 1000ms -> Leader resets +// Sticky: Leader stays active until timeout +// Example: Press Button 16 (leader) -> Press Button 0 (b) -> Result: shift+b +// Press Button 1 (p) -> Result: shift+p +// Press Button 2 (t) -> Result: shift+t +// Timeout after 1000ms -> Leader resets // -// Toggle: Leader toggles on/off -// Example: Press Button 16 (leader) -> Leader enabled -// Press Button 0 (b) -> Result: shift+b -// Press Button 1 (p) -> Result: shift+p -// Press Button 16 (leader) -> Leader disabled -// Press Button 0 (b) -> Result: b (normal) +// Toggle: Leader toggles on/off +// Example: Press Button 16 (leader) -> Leader enabled +// Press Button 0 (b) -> Result: shift+b +// Press Button 1 (p) -> Result: shift+p +// Press Button 16 (leader) -> Leader disabled +// Press Button 0 (b) -> Result: b (normal) // Default: one_shot // leader_button: 16