Skip to content

Commit 3794977

Browse files
committed
Update README for '24, trim whitespace.
1 parent 02645d7 commit 3794977

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<img src="https://github.com/mpaperno/WASimCommander/wiki/images/logo/WASim-Logo_640x160.png" style="width: auto;" />
1212
</div>
1313

14-
## Remote access to the Microsoft Flight Simulator 2020 "Gauge API."
14+
## Remote access to the Microsoft Flight Simulator 2020 & 2024 "Gauge API."
1515

1616
**A WASM module-based Server and a full Client API combination.**
1717

@@ -30,7 +30,7 @@ One of the motivations for this project was seeing multiple MSFS tool authors an
3030
own product or need. There is nothing wrong with this, of course, but for the Sim user it can be a disadvantage on several levels. They may end up running
3131
multiple versions of modules which all do essentially the same thing, and it may be confusing which WASM module they need to support which tool,
3232
just to name two obvious issues. For the developer, programming the WASM modules comes with its own quirks, too, not to mention the time involved.
33-
And regardless of the supposed isolated environment a WASM module is supposed to run in, it's still very easy to take down the whole Simulator with
33+
And regardless of the supposed isolated environment a WASM module is supposed to run in, it's still very easy to take down the whole Simulator with
3434
some errant code... ;-)
3535

3636
Since MS/Asobo have been, ahem, "slow" to add further remote access features to _SimConnect_ (or come up with some other method), this project is an attempt
@@ -44,25 +44,25 @@ On a more practical note, I am using it with the [MSFS Touch Portal Plugin](http
4444
#### Remote Capabilities
4545
- **Execute Calculator Code**:
4646
- With or without a returned result; Result returned as numeric and string types.
47-
- Formatted results from `format_calculator_string()` using
47+
- Formatted results from `format_calculator_string()` using
4848
[RPN String Formatting](https://docs.flightsimulator.com/html/Additional_Information/Reverse_Polish_Notation.htm#strings)
49-
- **Get Variable**: Return value result from any type of variable accessible to a standalone WASM module
50-
(basically everything but Gauge and Instrument types, but also including Token vars).
49+
- **Get Variable**: Return value result from any type of variable accessible to a standalone WASM module
50+
(basically everything but Gauge and Instrument types, but also including Token vars).
5151
- With optional Unit specifier for variable types which support it.
5252
- **Set Variable**: Set the value of any settable variable type, with optional Unit specifier for variable types which support it.
5353
- **Create Variable**: Create (and get/set) a new Local variable if it doesn't already exist.
5454
- **List Local Variables**: Get a list of all available 'L' variables with their names and current IDs.
5555
- **Lookup**: Return a numeric ID for a SimVar/Local/Token variable, Unit, or Key Event name.
5656
- **Subscribe** to _Calculator Code_ and _Get Variable_ results:
57-
- Get "push" notifications whenever result values change; Change monitoring can be configured at any rate down to the millisecond (~25ms minimum).
58-
Can also be configured to use the "delta epsilon" feature of SimConnect (to ignore insignificant changes in value) or, conversely, to always send
57+
- Get "push" notifications whenever result values change; Change monitoring can be configured at any rate down to the millisecond (~25ms minimum).
58+
Can also be configured to use the "delta epsilon" feature of SimConnect (to ignore insignificant changes in value) or, conversely, to always send
5959
updates even when values do not change.
6060
- Optionally perform manual ("polled") updates of subscriptions at any interval of your choice.
6161
- Any calculator code saved in subscriptions is **pre-compiled to a more efficient byte code** representation before being passed to the respective calculator
6262
functions. This significantly improves performance for recurring calculations.
6363
- **Register Named Events**:
64-
- Save recurring "set events," like activating controls using calculator code, for more efficient and simpler re-use.
65-
Saved calculator code is pre-compiled to a more efficient byte code representation before being passed to the calculator function.
64+
- Save recurring "set events," like activating controls using calculator code, for more efficient and simpler re-use.
65+
Saved calculator code is pre-compiled to a more efficient byte code representation before being passed to the calculator function.
6666
This significantly improves performance for recurring events.
6767
- Registered events can be executed "natively" via _WASim API_ by simply sending a short command with the saved event ID.
6868
- Saved events can also be named and executed via standard SimConnect commands `SimConnect_MapClientEventToSimEvent(id, "event_name")` and `SimConnect_TransmitClientEvent(id)`.
@@ -82,8 +82,8 @@ On a more practical note, I am using it with the [MSFS Touch Portal Plugin](http
8282
- No wasted data allocations, each data/variable subscription is stored independently avoiding complications with offsets or data overflows.
8383
- Minimum possible impact on MSFS in terms of memory and CPU usage; practically zero effect for Sim user when no clients are connected (Server is idle).
8484
- Server periodically checks that a client is still connected by sending "heartbeat" ping requests and enforcing a timeout if no response is received.
85-
- Extensive logging at configurable levels (debug/info/warning/etc) to multiple destinations (file/console/remote) for both Server and Client.
86-
- Uses an efficient **lazy logging** implementation which doesn't evaluate any arguments if the log message will be discarded anyway
85+
- Extensive logging at configurable levels (debug/info/warning/etc) to multiple destinations (file/console/remote) for both Server and Client.
86+
- Uses an efficient **lazy logging** implementation which doesn't evaluate any arguments if the log message will be discarded anyway
8787
(eg. a DEBUG level message when minimum logging level is INFO).
8888
- Logging levels can be set at startup via config files and changed at runtime for each facility (including remotely on the server).
8989
- Includes a SimConnect request/exception tracking feature for detailed diagnostics.
@@ -127,7 +127,7 @@ API documentation generated from source comments is published here: https://wasi
127127
A good place to start with the docs is probably the [`WASimClient`](https://wasimcommander.max.paperno.us/class_w_a_sim_commander_1_1_client_1_1_w_a_sim_client.html) page.
128128

129129
The GUI is written in C++ (using Qt library for UI), and while not the simplest example, _is_ a full implementation of almost all the available
130-
API features. The main `WASimClient` interactions all happen in the `MainWindow::Private` class at the top of the
130+
API features. The main `WASimClient` interactions all happen in the `MainWindow::Private` class at the top of the
131131
[WASimUi.cpp](https://github.com/mpaperno/WASimCommander/tree/main/src/WASimUI/WASimUI.cpp#L80) file.
132132

133133
More to come... or [Just Read The Source](https://github.com/mpaperno/WASimCommander/tree/main/src) :-)
@@ -170,8 +170,8 @@ There should be 2 console log messages from the module when it starts up, the la
170170
The module also logs to a file, though it's a bit tricky to find. On my edition (from MS store) the "working directory" for the modules is <br/>
171171
`D:\WpSystem\S-1-5-21-611220451-769921231-644967174-1000\AppData\Local\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\LocalState\packages\wasimcommander-module\work`
172172

173-
To enable more verbose logging on the module at startup, edit the `server_conf.ini` file which is found in the module's install folder
174-
(`Community\wasimcommander-module\modules`). There are comments in there indicating the options.
173+
To enable more verbose logging on the module at startup, edit the `server_conf.ini` file which is found in the module's install folder
174+
(`Community\wasimcommander-module\modules`). There are comments in there indicating the options.
175175

176176
Keep in mind that the server logging level can also be changed remotely at runtime, but
177177
of course that only works if you can establish a connection to the module in the first place.
@@ -180,12 +180,12 @@ of course that only works if you can establish a connection to the module in the
180180

181181
Basically the log is the primary source of information here. By default it logs at the "Info" level to:
182182
1) The current console window, assuming there is one (the host app is started from a console). So if using `WASimUI`, for example, just start it from a command prompt.
183-
2) A file in whatever current directory it is running in (so, for the UI, that would be the UI's install folder).
183+
2) A file in whatever current directory it is running in (so, for the UI, that would be the UI's install folder).
184184

185185
Of course if you're using `WASimUI`, it also provides a full logging interface and you can set all the log levels from there, for both client and server sides.
186186

187187
There should also be a `client_conf.ini` file alongside whatever is using the Client
188-
where initial logging location, levels and network configuration (timeout and SimConnect.cfg index) is set.
188+
where initial logging location, levels and network configuration (timeout and SimConnect.cfg index) is set.
189189
The config file has comments indicating the available options.
190190

191191
-------------
@@ -197,7 +197,7 @@ Use the [Issues](https://github.com/mpaperno/WASimCommander/issues) feature for
197197

198198
Use [Discussions](https://github.com/mpaperno/WASimCommander/discussions) for any other topic.
199199

200-
There is also a [Discord support forum](https://discord.gg/QhUDFX6Kun) on my server,
200+
There is also a [Discord support forum](https://discord.gg/QhUDFX6Kun) on my server,
201201
along with [release announcement](https://discord.gg/StbmZ2ZgsF) and [general chat](https://discord.gg/meWyE4dcAt) channels.
202202

203203
Most flight simulator forums seem fairly strict about _not_ using their site to provide product support. So please use GitHub,
@@ -239,8 +239,8 @@ or the GNU Lesser General Public License (**LGPL**), as published by the Free So
239239
Foundation, either **version 3** of the Licenses, or (at your option) any later version.
240240

241241
#### WASM Module Server and GUI Components
242-
Licensed under the terms of the GNU General Public License (**GPL**) as published by
243-
the Free Software Foundation, either **version 3** of the License, or (at your option)
242+
Licensed under the terms of the GNU General Public License (**GPL**) as published by
243+
the Free Software Foundation, either **version 3** of the License, or (at your option)
244244
any later version.
245245

246246
#### General
@@ -255,8 +255,8 @@ and are available at <http://www.gnu.org/licenses/>.
255255

256256
Except as contained in this copyright notice, the names of the authors or
257257
their institutions shall not be used in advertising or otherwise to
258-
promote the sale, use, or other dealings in, any product using this
259-
Software, or any derivative of this Software, without prior written
258+
promote the sale, use, or other dealings in, any product using this
259+
Software, or any derivative of this Software, without prior written
260260
authorization from the authors.
261261

262262
This project may also use 3rd-party Open Source software under the terms

0 commit comments

Comments
 (0)