Contains information and examples on connecting any sim to Shirley.
See the Changelog for the latest changes.
Shirley connects to a sim via WebSocket to receive SimData and send SetSimData messages.
See foreflight-type/README.md for more information.
From ForeFlight Documentation:
- AeroFly FS 4
- X-Plane 11 (Shirley natively supports X-Plane 12)
- Microsoft Flight Simulator 2020 & 2024
- Infinite Flight
A schema is available in the schemas directory. It is up-to-date as of the Shirley version in the Changelog. Shirley version numbers are listed at https://airplane.team/changelog.
SimDatais sent from the sim to Shirley (e.g. position and attitude). Any fields that are present are used by Shirley. So, it is very easy to gradually add more support for Shirley by sending additional fields. No specific support is required on Shirley's end.SetSimDatais sent from Shirley to the sim: it requires prior knowledge of the sim's supported settable data.- The
schemas/set_simdata_schemas_xplane.tsfile is specific to X-Plane 12, but can be used for other sims in generic-sim mode by adding?genericto the flight URL. - Extending to other sims is possible, but requires Shirley to be updated. Please contact us on Discord for support.
- The
DataDescriptordescribes the data that Shirley can access or set.schemas/data_descriptor.tsis a singleDataDescriptorfor a singleDataName.schemas/data_descriptors.tsis a map ofDataNametoDataDescriptor.
These schemas are subject to change as Shirley evolves.
Please contact us on Discord for the latest schemas for SimData and SetSimData, and for support in connecting your sim to Shirley!
Please star our repositories to show your support!
- Sample Challenges - Schemas and examples to help you utilize Shirley's powerful challenge system.
- Aircraft Profiles - Schemas and sample profiles to teach Shirley about your favorite aircraft.
- Sim Interface (this repo) - Complete interface to connect Shirley to any sim. Or, utilize the Shirley protocol for your own web-based sim plugin.