Fix the docs.rs build and improve the documentation

This commit is contained in:
Mihai Dinculescu
2022-10-21 14:59:22 +01:00
parent ea9236f3f6
commit 8ea0c17f99
11 changed files with 59 additions and 466 deletions

102
README.md
View File

@@ -1,11 +1,11 @@
# SimConnect SDK in Rust
# SimConnect SDK
[![Crates][crates_badge]][crates]
[![Documentation][documentation_badge]][documentation]
[![CI][ci_badge]][ci]
[![license][license_badge]][license]
[![Crates.io][crates_downloads_badge]][crates]\
An opinionated SimConnect SDK that encapsulates the C API fully and optimizes for developer experience.
An opinionated SimConnect Client that encapsulates the C API fully and optimizes for developer experience.
## Usage
@@ -88,102 +88,11 @@ See [more examples][examples].
## Contributing
Contributions are welcome and encouraged! See [/CONTRIBUTING.md][contributing].
Contributions are welcome and encouraged! See [CONTRIBUTING.md][contributing].
## Feature table
## Supported Features
### General
| Feature | Status | Comment |
| --------------------------------------- | ------- | ----------- |
| DispatchProc | | |
| SimConnect_Open | ✓ | |
| SimConnect_Close | ✓ | |
| SimConnect_CallDispatch | | |
| SimConnect_GetNextDispatch | ✓ | |
| SimConnect_RequestSystemState | | |
| SimConnect_MapClientEventToSimEvent | - | Coming soon |
| SimConnect_SubscribeToSystemEvent | | |
| SimConnect_SetSystemEventState | | |
| SimConnect_UnsubscribeFromSystemEvent | | |
| SimConnect_SetNotificationGroupPriority | - | Coming soon |
### Events And Data
| Feature | Status | Comment |
| -------------------------------------------- | ------- | ----------------------------------- |
| SimConnect_RequestDataOnSimObject | ✓ | Only for SIMCONNECT_OBJECT_ID_USER |
| SimConnect_RequestDataOnSimObjectType | - | Coming soon |
| SimConnect_AddClientEventToNotificationGroup | - | Coming soon |
| SimConnect_RemoveClientEvent | | |
| SimConnect_TransmitClientEvent | | |
| SimConnect_TransmitClientEvent_EX1 | | |
| SimConnect_MapClientDataNameToID | | |
| SimConnect_RequestClientData | | |
| SimConnect_CreateClientData | | |
| SimConnect_AddToClientDataDefinition | | |
| SimConnect_AddToDataDefinition | ✓ | Supports `f64`, `bool` and `String` |
| SimConnect_SetClientData | | |
| SimConnect_SetDataOnSimObject | | |
| SimConnect_ClearClientDataDefinition | | |
| SimConnect_ClearDataDefinition | ✓ | |
| SimConnect_MapInputEventToClientEvent | | |
| SimConnect_RequestNotificationGroup | | |
| SimConnect_ClearInputGroup | | |
| SimConnect_ClearNotificationGroup | | |
| SimConnect_RequestReservedKey | | |
| SimConnect_SetInputGroupPriority | | |
| SimConnect_SetInputGroupState | | |
| SimConnect_RemoveInputEvent | | |
### AI Objects
| Feature | Status | Comment |
| ------------------------------------- | ------ | ------- |
| SimConnect_AICreateEnrouteATCAircraft | | |
| SimConnect_AICreateNonATCAircraft | | |
| SimConnect_AICreateParkedATCAircraft | | |
| SimConnect_AICreateSimulatedObject | | |
| SimConnect_AIReleaseControl | | |
| SimConnect_AIRemoveObject | | |
| SimConnect_AISetAircraftFlightPlan | | |
### Flights
| Feature | Status | Comment |
| ------------------------- | ------ | ------- |
| SimConnect_FlightLoad | | |
| SimConnect_FlightSave | | |
| SimConnect_FlightPlanLoad | | |
### Debug
| Feature | Status | Comment |
| ------------------------------- | ------ | ------- |
| SimConnect_GetLastSentPacketID | | |
| SimConnect_RequestResponseTimes | | |
| SimConnect_InsertString | | |
| SimConnect_RetrieveString | | |
### Facilities
| Feature | Status | Comment |
| -------------------------------------- | ------- | ------- |
| SimConnect_AddToFacilityDefinition | | |
| SimConnect_RequestFacilitesList | ✓ | |
| SimConnect_RequestFacilitiesList_EX1 | | |
| SimConnect_RequestFacilityData | | |
| SimConnect_SubscribeToFacilities | ✓ | |
| SimConnect_SubscribeToFacilities_EX1 | | |
| SimConnect_UnsubscribeToFacilities | ✓ | |
| SimConnect_UnsubscribeToFacilities_EX1 | | |
### Missions
| Feature | Status | Comment |
| -------------------------------------- | ------ | ------- |
| SimConnect_CompleteCustomMissionAction | | |
| SimConnect_ExecuteMissionAction | | |
See [FEATURES.md][features].
## Credits
@@ -200,4 +109,5 @@ Inspired by [Sequal32/simconnect-rust][inspired_by].
[crates_downloads_badge]: https://img.shields.io/crates/d/simconnect-sdk?label=downloads
[examples]: https://github.com/mihai-dinculescu/simconnect-sdk/tree/main/examples
[contributing]: https://github.com/mihai-dinculescu/simconnect-sdk/blob/main/CONTRIBUTING.md
[features]: https://github.com/mihai-dinculescu/simconnect-sdk/blob/main/FEATURES.md
[inspired_by]: https://github.com/Sequal32/simconnect-rust