Skip to content

Commit

Permalink
Update CHANGELOG.md and README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
mpaperno committed Feb 15, 2022
1 parent 60e6769 commit 0fd538a
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 5 deletions.
43 changes: 43 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,48 @@
# MSFS Touch Portal Plugin - MP fork

## 0.6.0-mp (Feb-15-2022)
* Added support for sending numeric data values to the simulator with the various "Set" actions.
* Most/all "Set" actions have been broken out into their own separate action types. Since they now have a data field, it doesn't make sense to pair them with actions which don't use them, such as "Increment."
* Buttons which did *not* use the old "Set" choices, such as "Increment," etc, will continue to work (although they will still show the old choices in existing TP buttons until replaced with the new versions). However any buttons which relied on the old behavior of the "Set" action value always being `0` (zero) will need to be updated.
* Simple arithmetic operations (`+`, `-`, `*`, `/`, `%`, precedence with `( )`, scientific notation) are supported in most of the data fields which can be sent to the sim.
That means you can do things like `25 * 30`, but more interestingly one could use states/variables, like:
`"AP Set Alt. Hold to:" ${value:MSFSTouchPortalPlugin.AutoPilot.State.AutoPilotAltitudeVar} + 1000`
This evaluation could be expanded upon later if there is a need (to include higher math, rounding, etc).
* Generated documentation updated to include all Action Data attributes and mappings to the actual SimConnect events. Also added SimVar names to the list of States.
* New TP UI color for MSFS Plugin actions, "MSFS Blue."
* Action-to-event mapping syntax/scheme somewhat simplified and consolidated, for easier additions and maintenance. Now also allows custom event names (with a dot).
* Added new actions:
* AP Set Airspeed Hold Value
* AP Set Altitude Hold Value
* AP Set Heading Hold Value
* AP Set Mach Hold Value
* AP Set Vertical Speed Hold Value
* Magneto Switch 1/2/3/4 Set Position (0-4)
* Propeller All/1/2/3/4 Set Pitch Lever Value (0 to 16383)
* Throttle All/1/2/3/4 Set (-16383 - +16383)
* Engine 1/2/3/4 Anti-ice Switch Set On/Off
* Aileron Trim Set % (-100 - +100)
* Ailerons Position Set (-16383 - +16383)
* Elevator Trim Set (0 - 16383)
* Elevator Position Set (-16383 - +16383)
* Elevator Increment Up/Down
* Rudder Trim Set % (-100 - +100)
* Rudder Position Set (-16383 - +16383)
* Flaps Position Set (0 - 16383)
* Spoilers Position Set (0 - 16383)
* Modified actions:
* Toggle Flight Director removed useless choice selector with the one "toggle" option (there are no SimConnect events for specific on/off), **BREAKS CURRENT BUTTONS**
* Vertical Speed Hold added On/Off choices (in addition to Toggle which was the only one)
* Vertical Speed Value removed "Set Current" choice since there's no such Sim event to map to
* AP Nav Mode Switch 1/2, which never worked, now takes a value of 1 or 2 (that's how we have to set it up for now)
* Toggle All Magnetos - added new "Select for +/-" choice
* Engine Anti Ice Toggle removed Set choice (new action, above) which left only Toggle as 2nd choice, so that was removed **BREAKS CURRENT BUTTONS**
* Held Action Repeat Rate changed entirely, can now be Set to a specific value or Increment/Decrement by any step amount (in ms) **BREAKS CURRENT BUTTONS**
* Modified states:
* Plugin.State.Connected added "connecting" status which is active while SimConnect is not connected but is trying to be. "false" now indicates that it is disconnected and no attempts are being made to connect. **POSSIBLY BREAKS CURRENT BUTTONS** if they rely on the "false" status.

For some hints on using the new Set commands, check out the wiki page [Tips And Tricks For Setting Simulator Values](https://github.com/tlewis17/MSFSTouchPortalPlugin/wiki/Tips-And-Tricks-For-Setting-Simulator-Values).

## 0.5.4-mp (Feb-08-2022)
* Added support for "On Hold" type Touch Portal actions with a configurable repeat time.
All current actions which may make sense to repeat (such as for control surfaces or AP adjustments) should now be available in the "On Hold" TP button configuration page.
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/mpaperno/MSFSTouchPortalPlugin?include_prereleases)](https://github.com/mpaperno/MSFSTouchPortalPlugin/releases)
[![Downloads](https://img.shields.io/github/downloads/mpaperno/MSFSTouchPortalPlugin/total.svg)](https://github.com/mpaperno/MSFSTouchPortalPlugin/releases)
[![Downloads](https://img.shields.io/github/downloads/mpaperno/MSFSTouchPortalPlugin/0.5.4-mp/total)](https://github.com/mpaperno/MSFSTouchPortalPlugin/releases/tag/0.5.4-mp)
[![Downloads of latest release](https://img.shields.io/github/downloads/mpaperno/MSFSTouchPortalPlugin/latest/total)](https://github.com/mpaperno/MSFSTouchPortalPlugin/releases/latest)
[![Stars](https://img.shields.io/github/stars/mpaperno/MSFSTouchPortalPlugin)](https://github.com/Touch-Portal-MSFS/MSFSTouchPortalPlugin/stargazers)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

Expand All @@ -23,6 +23,8 @@ Another good page for use is created by TaxTips at: [FltSim-msfs2020-Control](ht

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

A [nascent wiki](https://github.com/tlewis17/MSFSTouchPortalPlugin/wiki/) is available with some tips.

## Installation Guide

Go to the releases:
Expand All @@ -42,10 +44,6 @@ https://github.com/FordMustang0288/MSFSTouchPortalPages

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 general support questions.

## Known Issues

* "Set" actions require data to be passed in and do not currently work.

## TODO

* Flight Instruments
Expand Down

0 comments on commit 0fd538a

Please sign in to comment.