MSFS 2020 TouchPortal Plugin - MP fork

Please note you're on the main branch for this fork (version). This README is specific to this version and repository. The master branch will stay synced with the original.

Overview

This plugin will provide a two way interface between Touch Portal and Microsoft Flight Simulator 2020 through SimConnect. This may work for other simulators that use SimConnect. A good starting point for pages would be to look at FordMustang0288's repo: MSFSTouchPortalPages. Another good page for use is created by TaxTips at: FltSim-msfs2020-Control. A (slightly dated) installation and usage guide is available at Simvol How to use Touch Portal [with MSFS].

Features

• Connects automatically through SimConnect
• Allows getting data variables from MSFS such as flight instruments or button/switch states.
• Allows triggering various aircraft components from a Touch Portal panel.

Documentation

Auto-generated documentation on all actions, states, and settings can be found in DOCUMENTATION.MD.

A nascent wiki is available with some tips.

Installation & Usage

1. Get the latest release of this plugin from the Releases page.
2. The plugin is distributed and installed as a standard Touch Portal .tpp plugin file. If you know how to import a plugin, just do that and skip to step 4. There is also a short guide on the Touch Portal site.
3. Import the plugin:
   1. Start Touch Portal (if not already running).
   2. Click the "gear" icon at the top and select "Import plugin..." from the menu.
   3. Browse to where you downloaded this plugin's .tpp file and select it.
4. Restart Touch Portal
   • When prompted by Touch Portal to trust the plugin startup script, select "Yes" (the source code is public!).

After that you will have a list of new actions you can choose from. Also "Dynamic Text" variables are now available. You can see them from the Dynamic Text Updater, or you can add an option for "On Plugin State Change" then select the corresponding state and "Changes to".

For buttons you use this like:

"On Plugin State Changes AutoPilot Master changes to 1" Then add whatever logic you want like button visuals. Duplicate this and add one for "does not change to 1" and that is when a button turns off.

This is very much a work in progress!

A comprehensive installation and usage guide was published on the Simvol Web site: How to use Touch Portal [with MSFS].

Sample Touch Portal page files can be found at FordMustang0288's MSFSTouchPortalPages and HiDTH's FltSim-msfs2020-Control

Update Notifications

The latest version of this software is always published on the GitHub Releases page. GitHub publishes an "Atom" (like RSS) feed with the latest version of any repository by adding .atom to the end o the URL. This reposotiry's release feed URL is:
https://github.com/mpaperno/MSFSTouchPortalPlugin/releases.atom

You have several options for getting automatically notified about new releases:

• If you have a GitHub account, just open the Watch menu of this repo in the top right of this page, then go to Custom and select the Releases option, then hit Apply button.
• If you already use an RSS/Atom feed reader, just subscribe to the feed URL shown above.
• Use an RSS/Atom feed notification service, either one specific for GitHub or a generic one, such as (a list of services I found, I haven't necessarily tried nor do I endorse any of these):
  • https://blogtrottr.com/ (generic RSS feed notifications, no account required, use feed URL shown above)
  • https://coderelease.io/ (no account required)
  • https://newreleases.io/
  • https://gitpunch.com/

I will also post update notices in the Touch Portal Discord server room #msfs2020

Support and Discussion

Please use the GitHub Issues pages for bug reports and concise feature requests. Use the Discussions pages for general conversation on any related topic like suggestions or support questions.

There is also a Touch Portal Discord server discussion room at #msfs2020

Related Plugin(s)

My TJoy Touch Portal Plugin is an interface between Touch Portal and several virtual joystick/gamepad emulation drivers like vJoy, vXBox, and ViGEm Bus.

TODO

• Flight Instruments
  • Pitch/Bank need to be times by -1.
• Sliders ("connectors")
• Events?

Documentation revamp

• Create interactive documentation site.
• Also generate base doc data into JSON file from code.
• Version selector
• Note tested/not tested
• Note Sim compatibility, may be useful on tested/not tested
• Filter by category
• Search
• Filter by Sim

References

• MSFS EventIds
• MSFS Variables
• FlightSimulator.com SDK Reference