Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "simconnect"
license = "MIT"
description = "Rust bindings for SimConnect"
version = "0.4.0"
version = "0.5.0"
authors = ["Connor T"]
edition = "2018"
edition = "2021"

[[example]]
name = "aircraft_updates_on_change"
Expand Down
29 changes: 20 additions & 9 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,18 @@

# SimConnect Bindings for Rust

Send and receive information through SimConnect, for Microsoft Flight Simulator (2020).

Documentation can be found at: [MSFS 2020 SDK](https://docs.flightsimulator.com/html/Programming_Tools/SimConnect/SimConnect_SDK.htm)


## Requirements

- [CLang](https://clang.llvm.org/get_started.html) (See the [Rust Bindgen Documentation](https://rust-lang.github.io/rust-bindgen/requirements.html))
- MSVC x64 Rust build (`x86_64-pc-windows-msvc`, see [The rustup book](https://rust-lang.github.io/rustup/installation/windows.html))
- [Rust](https://rust-lang.org/learn/get-started)
- [LLVM/Clang](https://clang.llvm.org/get_started.html)

See the [Rust Bindgen Documentation](https://rust-lang.github.io/rust-bindgen/introduction.html)


## Using

Expand All @@ -16,29 +24,32 @@ Add this to your `Cargo.toml`
simconnect = "0.4"
```

_You must have SimConnect.dll in the same directory as your executable._


## Building

_The SimConnect binaries are included within this repository, but they may not be up-to-date._

1. run `cargo build`
2. Add `use simconnect` at the top of your file
1. Run `cargo build`
2. Add import `use simconnect` at the top of your file


## Example
## Examples

Read float position data

```
cargo run --example aircraft_updates
```

Requests tagged data with thresholds from SimConnect and reads floats/strings
Requests tagged data with thresholds from SimConnect, and reads floats/strings

```
cargo run --example aircraft_updates_on_change
```

_You must have SimConnect.dll in the same directory as the compiled exe for it to run (e.g. in )_

### Remarks
## Remarks

I have not tested every single function from the api. If you find an error, feel free to make an issue or a pull request.
I have not tested every function of the API. If you find an error, feel free to make an issue or pull request.
Binary file modified SimConnect.dll
Binary file not shown.
Loading