14 releases
new 0.4.2 | Nov 19, 2024 |
---|---|
0.4.1 | Apr 22, 2024 |
0.4.0 | Mar 14, 2024 |
0.3.1 | Jun 1, 2020 |
0.1.1 | Dec 14, 2015 |
#70 in Graphics APIs
145 downloads per month
120KB
3K
SLoC
X-Plane plugin APIs for Rust
Purpose
Rust XPLM provides a convenient interface for X-Plane plugin development in the Rust programming language for all platforms.
As we use the X-Plane SDK version 3.0, any plugin created with this library supports X-Plane version 11.10 or later.
Status
The library is still in an incomplete state. As a result some parts of the SDK may only be sparsely covered or missing completely.
- Compiles and is callable from X-Plane
- Debug logging to the console / log file
- DataRef reading and writing
- Commands
- GUI - Needs further work
- Drawing - Needs further work
Example
Some more examples can be found in the examples/
directory.
This small snippet is the minimal boilerplate needed to make your plugin compile.
extern crate xplm;
use xplm::plugin::{Plugin, PluginInfo};
use xplm::{debugln, xplane_plugin};
struct MinimalPlugin;
impl Plugin for MinimalPlugin {
type Error = std::convert::Infallible;
fn start() -> Result<Self, Self::Error> {
// The following message should be visible in the developer console and the Log.txt file
debugln!("Hello, World! From the Minimal Rust Plugin");
Ok(MinimalPlugin)
}
fn info(&self) -> PluginInfo {
PluginInfo {
name: String::from("Minimal Rust Plugin"),
signature: String::from("org.samcrow.xplm.examples.minimal"),
description: String::from("A plugin written in Rust"),
}
}
}
xplane_plugin!(MinimalPlugin);
Compiling and installing a plugin
cargo new --lib my-rxplm-project
cd my-rxplm-project
cargo add xplm
Then add to Cargo.toml
:
[lib]
crate-type = ["cdylib"]
Copy minimal example from above into src/lib.rs
cargo build
Rename target/debug/my_rxplm_project.dll
to win.xpl
(or my_rxplm_project.so
to lin.xpl
, etc) and copy to the aircraft/scenery/sim plugins folder
Cross-compiling
The cross tool may help compile plugins for multiple operating systems/architectures.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~1.2–3.5MB
~52K SLoC