Changelog:

V1.1
- improve Keyboard mapping and key id
- added Keyboard layout identification and labelling of the image
- added mean to provide keyboard labels as JSON files
- added some keyboard label files
- fixes some found along the way

Author: bm98

.vs/MSFS2020Ctrls/v16/.suo

@@ -59,8 +59,7 @@ public Point FormLocation
 
     [UserScopedSetting( )]
     [DefaultSettingValue( "en-US" )] // just a default
-    public string MyLanguageChoice
-    {
+    public string MyLanguageChoice {
       get { return (string)this["MyLanguageChoice"]; }
       set { this["MyLanguageChoice"] = value; }
     }

AApp/AppSettings.cs

@@ -63,6 +63,14 @@ public FrmMain( )
       //lblTitle.Text += " - V " + version.Substring( 0, version.IndexOf( ".", version.IndexOf( "." ) + 1 ) ); // PRODUCTION
       this.Text += " - V " + version + " beta"; // BETA
 
+      // set the one from the kbd driver if found
+      bool exists = Support.KbdLayout.Instance.KbdLayoutExists(Support.InputTransform.KbdLayoutID);
+      Support.KbdLayout.Instance.SetKbdLayout( Support.InputTransform.KbdLayoutID ); // gets the default one if not found
+      if ( exists )
+        lblLang.Text = Support.InputTransform.LocaleString;
+      else
+        lblLang.Text = "("+Support.InputTransform.LocaleString+")";
+
       btLoad.Focus( );
 
     }
@@ -142,5 +150,20 @@ private void btPrint_Click( object sender, EventArgs e )
       PRINT = null;
     }
 
+    private void button1_Click( object sender, EventArgs e )
+    {
+      Support.KeyboardCls.MyLayoutName( );
+    }
+
+    private void button1_Click_1( object sender, EventArgs e )
+    {
+      var kle = new Support.KLE_File();
+      var x = new Support.KbdLayoutFile();
+      x.MapKLIDs = new List<string>( ) { "00000411" };
+      x.MapDescription = "Keyboard Layout for ja";
+      x.MapComment = "Japanese Layout";
+      x.MapKeys= kle.GetKeyLabels( "KBDJPN.json" );
+      x.ToJson( "ja.json" );
+    }
   }
 }

Doc/MSFS2020Ctrls_QGuide V1.pdf Doc/MSFS2020Ctrls_QGuide V1.00.pdfDoc/MSFS2020Ctrls_QGuide V1.pdf renamed to Doc/MSFS2020Ctrls_QGuide V1.00.pdf

@@ -53,7 +53,7 @@ class DeviceFile
     public List<string> SupportedPidVid {
       get {
         List<string> ret = new List<string>();
-        foreach( var id in InputDevices ) {
+        foreach ( var id in InputDevices ) {
           ret.AddRange( id.DevicePIDVID );
         }
         return ret;
@@ -63,13 +63,24 @@ public List<string> SupportedPidVid {
     /// <summary>
     /// Create all possible ShapeItems for this Mapping File
     /// </summary>
-    public void CreateShapes()
+    public void CreateShapes( )
     {
       for ( int i = 0; i < InputDevices.Count; i++ ) {
         InputDevices[i].CreateShapes( );
       }
     }
 
+    /// <summary>
+    /// Create all possible KeyLabels when the controls requires it
+    /// </summary>
+    /// <param name="dList">A Display List</param>
+    public void LoadKeyLabels( DisplayList dList )
+    {
+      for ( int i = 0; i < InputDevices.Count; i++ ) {
+        InputDevices[i].LoadKeyLabels( dList );
+      }
+    }
+
     /// <summary>
     /// Find a Control entry with the given product guid and input command
     /// </summary>
@@ -101,7 +112,7 @@ public Control FindItem( string pidVid, string input, bool firstInstance )
     /// Get all devices with Name (only first GUID is returned)
     /// </summary>
     /// <returns></returns>
-    public List<Device.DeviceDescriptor> Devices()
+    public List<Device.DeviceDescriptor> Devices( )
     {
       var ret = new List<Device.DeviceDescriptor>( );
       for ( int i = 0; i < InputDevices.Count; i++ ) {
@@ -127,21 +138,26 @@ class Device
     [DataMember( Name = "DeviceName", IsRequired = true )]
     public string DeviceName { get; set; } // The device name
 
-    [DataMember(Name = "DeviceProdGuid", IsRequired = true )]
+    [DataMember( Name = "DeviceProdGuid", IsRequired = true )]
     private List<string> DeviceProdGuid_ { get; set; } = new List<string>( ); // The device product GUIDs as read by DirectInput
 
-    [DataMember(Name = "Controls" )]
+    [DataMember( Name = "Controls" )]
     public List<Control> Controls { get; set; } = new List<Control>( );// The list of Controls supported (see below)
 
     // non Json
 
+    public bool IsInputType_Joystick => InputTypeLetter == "J";
+    public bool IsInputType_Gamepad => InputTypeLetter == "G";
+    public bool IsInputType_Mouse => InputTypeLetter == "M";
+    public bool IsInputType_Kbd => InputTypeLetter == "K";
+    public bool IsInputType_Kbd_Keys => InputTypeLetter == "X";
+
 
     private Font m_deviceFont = null;
     /// <summary>
     /// Get the base font for this device
     /// </summary>
-    public Font DeviceFont
-    {
+    public Font DeviceFont {
       get {
         if ( !string.IsNullOrEmpty( FontFamily ) ) {
           return m_deviceFont;
@@ -158,23 +174,21 @@ public class DeviceDescriptor
     {
       public string DevGuid { get; set; } = "";
       public string DevName { get; set; } = "";
-      public override string ToString()
+      public override string ToString( )
       {
         return DevName;
       }
     }
 
-    public DeviceDescriptor DevDescriptor
-    {
+    public DeviceDescriptor DevDescriptor {
       get {
-        return new DeviceDescriptor( ) { DevGuid = DeviceProdGuid_[0].ToLowerInvariant(), DevName = DeviceName };
+        return new DeviceDescriptor( ) { DevGuid = DeviceProdGuid_[0].ToLowerInvariant( ), DevName = DeviceName };
       }
     }
 
 
     public string InputTypeLetter { get => InputType.Substring( 0, 1 ); }
-    public int InputTypeNumber
-    {
+    public int InputTypeNumber {
       get {
         if ( InputType.Length > 1 ) {
           if ( int.TryParse( InputType.Substring( 1 ), out int num ) ) {
@@ -188,8 +202,7 @@ public int InputTypeNumber
     /// <summary>
     /// returns the PID VID part of the GUID (seems how this is composed in Win)
     /// </summary>
-    public List<string> DevicePIDVID
-    {
+    public List<string> DevicePIDVID {
       get {
         var ret = new List<string>( );
         foreach ( string s in DeviceProdGuid_ ) {
@@ -207,7 +220,7 @@ public List<string> DevicePIDVID
     private int m_kbdItemTracker = 0;
     /// <summary>
     /// Find a Control entry with the given input command
-    /// For Keyboards there is not an entry for every possible key - so return just the next one
+    /// For Keyboards with drawn Keys there is not an entry for every possible key - so return just the next one
     /// </summary>
     /// <param name="input">the Item (device property)</param>
     /// <returns>The found Control or Null</returns>
@@ -219,8 +232,8 @@ public Control FindItem( string input )
           return Controls[i];
         }
       }
-      // if not - and Keyboard - assign a new one and tag it
-      if ( this.InputTypeLetter == "X" ) {
+      // if not - and Keyboard with drawn Keys - assign a new one and tag it
+      if ( this.IsInputType_Kbd_Keys ) {
         if ( Controls.Count > m_kbdItemTracker ) {
           int item = m_kbdItemTracker++;
           Controls[item].Input = input; // mark to reuse
@@ -234,15 +247,25 @@ public Control FindItem( string input )
     /// <summary>
     /// Create all possible ShapeItems for this Device
     /// </summary>
-    public void CreateShapes()
+    public void CreateShapes( )
     {
       m_kbdItemTracker = 0; // reset 
       if ( m_deviceFont != null ) m_deviceFont.Dispose( );
       if ( !string.IsNullOrEmpty( FontFamily ) ) {
         m_deviceFont = new Font( FontFamily, MapProps.FontSize ); // create actual Font here
       }
       for ( int i = 0; i < Controls.Count; i++ ) {
-        Controls[i].CreateShapes( DeviceFont, this.InputTypeLetter == "X" ); // symbols only for X type maps (keyboard with Symbols)
+        Controls[i].CreateShapes( DeviceFont, this.IsInputType_Kbd_Keys ); // symbols only for X type maps (keyboard with Symbols)
+      }
+    }
+    /// <summary>
+    /// Create all possible KeyLabels when the control requires it
+    /// </summary>
+    /// <param name="dList"></param>
+    public void LoadKeyLabels( DisplayList dList )
+    {
+      for ( int i = 0; i < Controls.Count; i++ ) {
+        Controls[i].LoadKeyLabels( dList, this.IsInputType_Kbd_Keys ); // symbols only for X type maps (keyboard with Symbols)
       }
     }
 
@@ -258,7 +281,7 @@ class Control
     public string Input { get; set; } = ""; // buttonN, hatN_up,_right,_down,_left, [rot]xyz, sliderN (CryInput notification)
 
     [DataMember( Name = "Type" )]
-    public string Type { get; set; } = "";  // "" or Analog or Digital
+    public string Type { get; set; } = "";  // "" or Analog or Digital or Key
 
     [DataMember( Name = "X", IsRequired = true )]
     public int X { get; set; } = 0;         // X label pos (left=0)
@@ -293,6 +316,8 @@ class Control
     /// </summary>
     public void CreateShapes( Font deviceFontRef, bool useSymbol )
     {
+      // define the number of Actionlabels to fit into the Control rectangle
+
       // this is a bit messy...
       // have to allocate a number of Rectangles to draw into but the layout rects are very different in size..
       this.ShapeItems = new Queue<ShapeItem>( ); // get rid of previous ones
@@ -312,22 +337,40 @@ public void CreateShapes( Font deviceFontRef, bool useSymbol )
       }
       baseHeight = (int)Math.Floor( (double)Height / nLines ); // fill rectangle
 
+      // create as many shapes to hold action labels for this control
       bool symbol = useSymbol;
+      // create one to draw the whole key
+      if ( this.Type == "Key" && useSymbol ) {
+        // Type Keyboard with keys drawn
+        var sh = new ShapeKey {
+          X = this.X,
+          Y = this.Y,
+          Width = this.Width,
+          Height = this.Height/2,
+          IsSymbolShape = true,
+          TextFontRef = MapProps.KbdSymbolFont,
+        };
+        ShapeItems.Enqueue( sh ); // will only be drawn when used
+      }
+
       for ( int l = 0; l < nLines; l++ ) {
         for ( int c = 0; c < nCols; c++ ) {
-          if ( this.Type == "Key" ) {
+
+          if ( this.Type == "KeyS" ) {
+            // Type Keyboard with keys drawn
             var sh = new ShapeKey {
               X = X + c * baseWidth,
               Y = Y + l * baseHeight,
               Width = baseWidth,
               Height = baseHeight,
-              IsSymbolShape = symbol,
+              IsSymbolShape = false,
               TextFontRef = deviceFontRef
             };
             symbol = false; // only once
             ShapeItems.Enqueue( sh );
           }
           else {
+            // other types - create labels only
             var sh = new ShapeItem {
               X = X + c * baseWidth,
               Y = Y + l * baseHeight,
@@ -341,6 +384,27 @@ public void CreateShapes( Font deviceFontRef, bool useSymbol )
       }
     }
 
+    /// <summary>
+    /// Load KeyLabels if required by the control and mode (not if using symbols though)
+    /// </summary>
+    /// <param name="dList">A display list to add them</param>
+    /// <param name="useSymbol">Wether or not usin Key Symbols rather than a drawn map</param>
+    public void LoadKeyLabels( DisplayList dList, bool useSymbol )
+    {
+      if ( this.Type == "Key" && !useSymbol ) {
+        // Type Keyboard with keys drawn
+        var sh = new ShapeKey {
+          X = this.X,
+          Y = this.Y,
+          Width = this.Width,
+          Height = this.Height/2,
+          IsLabelShape = true,
+          DispText="DUMMY",
+          SCGameKey = this.Input,
+        };
+        dList.Add( sh );
+      }
 
+    }
   }
 }

Doc/MSFS2020Ctrls_QGuide V1.1.pdf

@@ -347,26 +347,30 @@ private void Populate( )
         return;
       }
 
-      ( cbxLayouts.SelectedItem as DeviceLayout ).DeviceController.CreateShapes( );
+      var devController=( cbxLayouts.SelectedItem as DeviceLayout ).DeviceController;
+      devController.CreateShapes( );
+      devController.LoadKeyLabels( m_displayList );
       foreach ( var actItem in ActionList ) {
         // matches the selected device      
         if ( MatchCriteria( actItem ) ) {
           bool firstInstance = ActionList.IsFirstInstance( actItem.DevicePidVid, actItem.InputTypeNumber );
-          var ctrl = ( cbxLayouts.SelectedItem as DeviceLayout ).DeviceController.FindItem( actItem.DevicePidVid, actItem.MainControl, firstInstance );
+          var ctrl = devController.FindItem( actItem.DevicePidVid, actItem.MainControl, firstInstance );
           if ( ctrl == null && actItem.InputTypeLetter == "J" ) {
             // for joysticks try the generic one
-            ctrl = ( cbxLayouts.SelectedItem as DeviceLayout ).DeviceController.FindItem( "20002000", actItem.MainControl, firstInstance );
+            ctrl = devController.FindItem( "20002000", actItem.MainControl, firstInstance );
           }
           if ( ctrl != null ) {
             if ( ctrl.ShapeItems.Count > 0 ) {
               var shape = ctrl.ShapeItems.Dequeue( );
+              if (shape is ShapeKey ) {
+                ( shape as ShapeKey ).SCGameKey = actItem.MainControl; // content
+                shape.DispText = "DUMMY"; // else it is ignored.. TODO make this better...
+                m_displayList.Add( shape );
+                shape = ctrl.ShapeItems.Dequeue( ); // pull one more if we got a non text shape
+              }
               shape.DispText = actItem.ModdedDispText;
               shape.TextColor = MapProps.MapForeColor( actItem.ActionMap );
               shape.BackColor = MapProps.MapBackColor( actItem.ActionMap );
-              if ( shape is ShapeKey ) {
-                // kbd map
-                ( shape as ShapeKey ).SCGameKey = actItem.MainControl;
-              }
               m_displayList.Add( shape );
             }
             else {