Skip to content

Commit

Permalink
Update CHANGELOG, README and generated files.
Browse files Browse the repository at this point in the history
  • Loading branch information
mpaperno committed Sep 3, 2023
1 parent 3dbd000 commit ff6adfb
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 11 deletions.
30 changes: 29 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# MSFS Touch Portal Plugin Change Log
# MSFS/FSX Touch Portal Plugin Change Log

## 1.4.3.3 (Sept-3-2023)
Version number: `1040303`

* Fixed simulator event actions not working after a re-connection to the sim when WASM integration is unavailable (eg. FSX edition).
* Fixed "Avionics Master Switch" action missing choices list of what to actually do.
* Fixed that "Starters Set" action was not available in On Hold tab.
* Added better handling of Sim Var request errors based on SimConnect responses -- invalid requests should now be automatically removed or suspended (with details logged).
* Added ability to specify a required simulator version for particular Sim Var request definitions (eg. only MSFS/v11).

---
## 1.4.3.2 (Sept-2-2023 @ flightsim.to)
Version number: `1040301`

* Allow running the FSX plugin concurrently with MSFS plugin.

---
## 1.4.3.1 (Sept-2-2023 @ flightsim.to)
Version number: `1040301`

* Initial release of "FSX" version of the plugin for older sims (FSX Deluxe SP2 or newer).

---
## 1.4.3.0 (Sept-1-2023 - limited test)
Version number: `1040300`

* Fixed requests for local ('L') variables with 'Millisecond' type update period not working when WASM integration is used.

---
## 1.4.2.0 (Aug-5-2023)
Version number: `1040200`

Expand Down
5 changes: 3 additions & 2 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This plugin provides a two-way interface between Touch Portal and Flight Simulat

For further documentation, please see https://github.com/mpaperno/MSFSTouchPortalPlugin/wiki

This documentation generated for plugin v1.4.2.0
This documentation generated for plugin v1.4.3.3

---

Expand Down Expand Up @@ -879,6 +879,7 @@ Range:{6}-{7}</td><td><ol start=0>
<td><details><summary><sub>details</sub></summary><dl><dt>Master</dt><dd>TOGGLE_MASTER_ALTERNATOR</dd><dt>1</dt><dd>TOGGLE_ALTERNATOR1</dd><dt>2</dt><dd>TOGGLE_ALTERNATOR2</dd><dt>3</dt><dd>TOGGLE_ALTERNATOR3</dd><dt>4</dt><dd>TOGGLE_ALTERNATOR4</dd></dl></details></td>
<td align='center'></td></tr>
<tr valign='top'><td>Avionics Master Switch</td><td></td><td>Avionics {0}</td><td><ol start=0>
<li>[choice] &nbsp; <b>Master Toggle</b>, Master 1 Off, Master 1 On, Master 2 Off, Master 2 On</li>
</ol></td>
<td><details><summary><sub>details</sub></summary><dl><dt>Master Toggle</dt><dd>TOGGLE_AVIONICS_MASTER</dd><dt>Master 1 Off</dt><dd>AVIONICS_MASTER_1_OFF</dd><dt>Master 1 On</dt><dd>AVIONICS_MASTER_1_ON</dd><dt>Master 2 Off</dt><dd>AVIONICS_MASTER_2_OFF</dd><dt>Master 2 On</dt><dd>AVIONICS_MASTER_2_ON</dd></dl></details></td>
<td align='center'></td></tr>
Expand Down Expand Up @@ -1066,7 +1067,7 @@ Range:{5}-{6}</td><td><ol start=0>
<li>[number] &nbsp; <b>1</b> &nbsp; <sub>&lt;min: 0&gt;</sub> <sub>&lt;max: 1&gt;</sub></li>
</ol></td>
<td><details><summary><sub>details</sub></summary><dl><dt>All+Set</dt><dd>STARTER_SET</dd><dt>1+Set</dt><dd>STARTER1_SET</dd><dt>2+Set</dt><dd>STARTER2_SET</dd><dt>3+Set</dt><dd>STARTER3_SET</dd><dt>4+Set</dt><dd>STARTER4_SET</dd><dt>All+Set Held</dt><dd>SET_STARTER_ALL_HELD</dd><dt>1+Set Held</dt><dd>SET_STARTER1__HELD</dd><dt>2+Set Held</dt><dd>SET_STARTER2__HELD</dd><dt>3+Set Held</dt><dd>SET_STARTER3__HELD</dd><dt>4+Set Held</dt><dd>SET_STARTER4__HELD</dd></dl></details></td>
<td align='center'></td></tr>
<td align='center'>&#9745;</td></tr>
<tr valign='top'><td>Starters Toggle</td><td></td><td>Toggle Starter - {0}</td><td><ol start=0>
<li>[choice] &nbsp; <b>All</b>, 1, 2, 3, 4, Master Switch</li>
</ol></td>
Expand Down
22 changes: 18 additions & 4 deletions MSFSTouchPortalPlugin/entry.tp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"sdk": 6,
"version": 1040200,
"version": 1040303,
"name": "MSFS Touch Portal Plugin",
"id": "MSFSTouchPortalPlugin",
"configuration": {
Expand Down Expand Up @@ -3253,8 +3253,22 @@
"tryInline": true,
"hasHoldFunctionality": false,
"description": "",
"format": "Avionics {0}",
"data": []
"format": "Avionics {$MSFSTouchPortalPlugin.Electrical.Action.AvionicsMasterSwitchAdj.Data.0$}",
"data": [
{
"id": "MSFSTouchPortalPlugin.Electrical.Action.AvionicsMasterSwitchAdj.Data.0",
"type": "choice",
"label": "Action",
"default": "Master Toggle",
"valueChoices": [
"Master Toggle",
"Master 1 Off",
"Master 1 On",
"Master 2 Off",
"Master 2 On"
]
}
]
},
{
"id": "MSFSTouchPortalPlugin.Electrical.Action.ExternalPower",
Expand Down Expand Up @@ -4076,7 +4090,7 @@
"prefix": "MSFS",
"type": "communicate",
"tryInline": true,
"hasHoldFunctionality": false,
"hasHoldFunctionality": true,
"description": "",
"format": "Starter {$MSFSTouchPortalPlugin.Engine.Action.StartersSet.Data.0$} {$MSFSTouchPortalPlugin.Engine.Action.StartersSet.Data.1$} to {$MSFSTouchPortalPlugin.Engine.Action.StartersSet.Data.2$} (0/1)",
"data": [
Expand Down
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ This project is a continuation of the original [MSFSTouchPortalPlugin by Tim Lew
accessible via SimConnect alone.
* Categorized lists of all SimConnect Event IDs and Simulator Variables to choose from, custom imported from MSFS online documentation (exclusive feature!).
* Integrates live HubHop data for activating thousands of available Input Events provided by the community (requires WASM integration).
* Separate plugins available for MSFS 2020 and older sims supporting FS-X versions of SimConnect.


## Documentation
Expand All @@ -46,12 +47,22 @@ See the [Wiki](https://github.com/mpaperno/MSFSTouchPortalPlugin/wiki/) for guid
Auto-generated documentation on all actions, connectors, events, settings, and default included states can be found in [DOCUMENTATION.md](DOCUMENTATION.md).


## Editions

There are two separate plugins available here, one for MSFS 2020 (and eventually 2024), and another for "legacy" sims like FSX,
which should work with any sim which supports the older SimConnect SDK.
* The "MSFS" edition is recommended for use with MSFS 2020 since it provides features specific to this version (like setting 'L' vars and WASM integration).
* The "FSX" edition will connect to FSX Deluxe SP2 or newer simulators (including Steam and Acceleration editions).
This also includes MSFS 2020, but will not support certain features like WASM and HubHop integration or setting multiple SimConnect Event values.
* The two plugin editions are completely separate and can be installed and run in Touch Portal at the same time.
* Pages and buttons made for one edition will not work in the other (because they're separate plugins as far as TP is concerned).

## Installation

Note: As with all plugins, this requires the Touch Portal Pro (paid) version to function. Use the latest available Touch Portal version for best results.

1. Get the latest release of this plugin from the [Releases](https://github.com/mpaperno/MSFSTouchPortalPlugin/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.
1. Get the latest release of this plugin(s) you want to install from the [Releases](https://github.com/mpaperno/MSFSTouchPortalPlugin/releases) page.
2. The plugins are distributed and installed as a standard Touch Portal `.tpp` plugin files. If you know how to import a plugin, just do that and skip to step 4.
3. Import the plugin:
1. Start/open _Touch Portal_.
2. Click the Settings "gear" icon at the top-right and select "Import plugin..." from the menu.
Expand All @@ -67,11 +78,10 @@ Note: As with all plugins, this requires the Touch Portal Pro (paid) version to
then navigate to _Settings -> Plugins -> "MSFS Touch Portal Plugin"_. Set the
"Connect To Flight Sim on Startup" setting to a value of `1` (one) and save the settings.
The plugin will keep attempting to connect to the simulator every 30 seconds.
5. **For use with FS-X** (and compatible sims): Change the "SimConnect.cfg Index" plugin setting to `1` (one).

### Optional WASM Module (only for MSFS 2020 on PC)

6. The optional `WASimModule` MSFS component is **highly recommended** as a companion to this plugin. It it not required to use most
5. The optional `WASimModule` MSFS component is **highly recommended** as a companion to this plugin. It it not required to use most
of the basic plugin features, but it will provide a more advanced feature set (such as access to local "L" variables and HubHop Input Events)
and further optimizations.
1. Download the `WASimModule` .zip file from the same published Release as the plugin.
Expand Down

0 comments on commit ff6adfb

Please sign in to comment.