diff --git a/docs/_includes/components/sidebar.html b/docs/_includes/components/sidebar.html
new file mode 100644
index 00000000..13c755bd
--- /dev/null
+++ b/docs/_includes/components/sidebar.html
@@ -0,0 +1,32 @@
+{%- comment -%}
+ Include as: {%- include components/sidebar.html -%}
+ Depends on: page(?), site.
+ Results in: HTML for the side bar.
+ Includes:
+ title.html, components/site_nav.html, nav_footer_custom.html
+ Overwrites:
+ nav_footer_custom.
+ Should not be cached, because nav_footer_custom.html might depend on page.
+{%- endcomment -%}
+
+
diff --git a/docs/_includes/components/site_nav.html b/docs/_includes/components/site_nav.html
new file mode 100644
index 00000000..12a9ffc1
--- /dev/null
+++ b/docs/_includes/components/site_nav.html
@@ -0,0 +1,67 @@
+{%- comment -%}
+ Include as: {%- include_cached components/site_nav.html -%}
+ Depends on: site.
+ Results in: HTML for the site-nav.
+ Includes:
+ components/nav.html
+ Overwrites:
+ pages_top_size, collections_size, collection_entry,
+ collection_key, collection_value, collection.
+{%- endcomment -%}
+
+
diff --git a/docs/_includes/site_nav.html b/docs/_includes/site_nav.html
new file mode 100644
index 00000000..12a9ffc1
--- /dev/null
+++ b/docs/_includes/site_nav.html
@@ -0,0 +1,67 @@
+{%- comment -%}
+ Include as: {%- include_cached components/site_nav.html -%}
+ Depends on: site.
+ Results in: HTML for the site-nav.
+ Includes:
+ components/nav.html
+ Overwrites:
+ pages_top_size, collections_size, collection_entry,
+ collection_key, collection_value, collection.
+{%- endcomment -%}
+
+
diff --git a/docs/_layouts/api_group_page.html b/docs/_layouts/api_group_page.html
new file mode 100644
index 00000000..84f03f7f
--- /dev/null
+++ b/docs/_layouts/api_group_page.html
@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}
\ No newline at end of file
diff --git a/docs/_layouts/api_page.html b/docs/_layouts/api_page.html
new file mode 100644
index 00000000..84f03f7f
--- /dev/null
+++ b/docs/_layouts/api_page.html
@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}
\ No newline at end of file
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index 03084f46..2a73e3ea 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -1,53 +1,41 @@
-
-
-
-
-
-
-
-
-
-{% seo %}
- {% include head-custom.html %}
-
+---
+layout: table_wrappers
+---
-
+
-
-
-
- {% if site.github.is_project_page %}
- View on GitHub
+
+{% include head.html %}
+
+ Skip to main content
+ {% include icons/icons.html %}
+ {% include components/sidebar.html %}
+
It’s best to use the Settings application and the transport / processing plugins for Settings to manipulate the file. However, if you edit it by hand, here are some notes.
The File location is Restricted
The JSON configuration files are all stored in %allusersprofile%\Microsoft\MIDI which typically resolves to C:\ProgramData\Microsoft\MIDI. For security reasons, we don’t allow the file to be stored in any other location. However, you can have as many files in that folder as you want, and switch between them as needed.
The default config file is typically named Default.midiconfig.json. The actual name is stored in the registry under HKLM\SOFTWARE\Microsoft\Windows MIDI Services in the CurrentConfig value. This value must not contain any non-filename path characters (no backslashes, colons, etc.).
JSON is Case-Sensitive
JSON is typically case-sensitive for all keys. The Windows.Data.Json parser used by Windows MIDI Services is case-sensitive with no option to ignore case. That includes GUID values. For example, the following two values are not equivalent JSON keys:
The JSON config file is such that each transport owns its own schema within the bucket associated with its class ID (GUID). We do not impose a schema on the transports or other plugins. Therefore there is no formal JSON Schema for this file.
Here’s an example of a bare-bones file, with sections for three different transports.
The basics of this are identical for each transport. We’ll use KS (USB) as an example
"{26FA740D-469C-4D33-BEB1-3885DE7D6DF1}":
+{
+ "_comment":"KS MIDI (USB etc.)"
+ "SWD: \\\\?\\SWD#MIDISRV#MIDIU_KS_BIDI_6799286025327820155_OUTPIN.0_INPIN.2#{e7cce071-3c03-423f-88d3-f1045d02552b}":
+ {
+ "userSuppliedName":"Pete's Kontrol S61",
+ "userSuppliedDescription":"This is my most favorite MIDI 2.0 controller in the whole world!"
+ }
+ ...
+},
+
Of those, the identification method SWD is the most important. This controls how we identify a matching device. In cases where the manufacturer doesn’t supply a unique iSerialNumber in USB, unplugging your device from one USB port and plugging it into another can result in a new Id. Similarly, if you have two or more of the same device, and they do not have unique serial numbers, it can be impossible for Windows to distinguish between them.
Valid values for the identification method prefix
SWD: : (The colon and trailing space are required). Use the full Windows Endpoint Device Interface Id. For example \\\\?\\SWD#MIDISRV#MIDIU_KS_BIDI_16024944077548273316_OUTPIN.0_INPIN.2#{e7cce071-3c03-423f-88d3-f1045d02552b}. (Note how the backslashes have to be escaped with additional backslashes.) If the device has an iSerialNumber or you never move it between USB ports, this tends to work fine.
(other methods to be added here when we implement them)
Valid properties you can set across all supported endpoints
Property
Type
Description
userSuppliedName
Quoted Text
The name you want to use for the endpoint. This will override the name displayed in correctly-coded applications, but won’t necessarily change what you see in Device Manager. These names should be relatively short so they display fully in all/most applications, but meaningful to you.
userSuppliedDescription
Quoted Text
A text description and/or notes about the endpoint. Applications may or may not use this data
forceSingleClientOnly
Boolean true/false (no quotes)
Most endpoints are multi-client (more than one application can use them simultaneously) by default. This setting is for forcing an endpoint to be single-client only (a value of true). It’s unusual to need this, but a typical use may be to disable multi-client for a device which has a custom driver which doesn’t gracefully handle multiple client applications at the same time.
Plugin-specific settings
This is not an exhaustive list, because the transport and processing plugins may be created by anyone.
Virtual MIDI
Virtual MIDI includes three different sections inside its transport bucket.
For the persistent configuration file, typically “add” is all that is specified, as it doesn’t make sense to update or remove endpoints or routing on service start.
NOTE: This document is not yet complete. We’ll add more details as the schemas are finalized
KS (USB etc) MIDI
TODO: Show how to update endpoint names and provide other properties here