Protocol Documentation

The position on the map we want the wind information for. Requires lat/lon/alt fields to be populated, there are no default values

The temperature in Kelvin

The pressure in Pascals

The position on the map we want the wind information for. Requires lat/lon/alt fields to be populated, there are no default values

The heading the wind is coming from.

The strength of the wind in meters per second

The position on the map we want the wind information for. Requires lat/lon/alt fields to be populated, there are no default values

The heading the wind is coming from.

The strength of the wind in meters per second.

The coalition is determined by the provided Country and the coalition setup of the mission

the name of the static; must be unique or would destroy previous object

country the unit belongs to

type of the static object (e.g. "Farm A", "AS32-31A")

string name of the livery for the aircraft

boolean for whether or not the object will appear as a wreck

number value for the "score" of the object when it is killed

the name of the unit to offset from

the angle to relative to the linked unit, in a clockwise direction. negative values are anti-clockwise

x offset from linked unit center (positive is forward; negative is aft)

y offset from linked unit center (positive is starboard-side; negative is port-side)

the name of the static; must be unique or would destroy previous object

country the unit belongs to

type of the static object (e.g. "Farm A", "AS32-31A")

string name of the livery for the aircraft

boolean for whether or not the object will appear as a wreck

number value for the "score" of the object when it is killed

cargo mass in kilograms

A specific coalition must be used for this API call. Do not use `COALITION_ALL`

the coalition which the statics belong to

the list of statics

Information about the unit, if the airbase is one (e.g. in case of a carrier).

TODO: Fill this in

TODO: Fill this in

The coalition the unit belongs to. This can change mid-mission if an airfield is captured

The position of the center point of the airfield.

What category the airfield belongs to.

TODO: Fill this in

The DCS generated ID

Can the sensor see the contact

Does the controller know the distance to the contact?

The DCS generated ID

The name of the group as assigned in the mission editor

The coalition of the group

The group category.

Latitude in Decimal Degrees format

Longitude in Decimal Degrees format

Altitude in Meters above Mean Sea Level (MSL)

The id of the mark panel.

The time in seconds relative to the mission start the mark got created.

The unit of the player that created the mark. Not set if the player isn't controlling any unit anymore (disconnected, spectator, game master, ...).

If set, the mark is only visible for the specified coalition.

The ID of the group the player was in when creating the mark panel. This will still be set even if the player isn't controlling the unit in that group anymore.

The text content of the mark.

The position of the mark.

The heading the nose of the object points to on a flat world.

Yaw in degrees - clockwise relative to the true north (this is similar to the heading, just corrected by the projection error when going from a flat to a spherical world).

Pitch in degrees - positive when taking-off.

Roll in degrees - positive when rolling the aircraft to the right.

The normalized direction the object is pointing to.

The normalized direction the three line (right wing) is pointing to.

The normalized up vector (orthogonal to forward and right).

Latitude in Decimal Degrees format

Longitude in Decimal Degrees format

Altitude in Meters above Mean Sea Level (MSL)

Distance between DCS' map origin to object in meters on west-east axis.

Distance between DCS' map origin to object in meters on north-south axis.

The id of the scenery

The DCS type-name of the scenery

The position of the scenery

The DCS generated ID

The DCS type-name of the static

The name of the static

The coalition the static belongs to

The position of the static

The DCS generated ID

The name of the unit as assigned in the mission editor

The DCS assigned callsign if one exists. e.g. "Enfield 11"

The coalition the unit belongs to

The DCS type-name of the unit. e.g "MiG-29A", "ZSU_57_2" or "Hawk ln"

The position of the unit

The orientation of the unit in both 2D and 3D space

The velocity of the unit in both 2D and 3D space

The name of the player if one is in control of the unit

The group that the unit belongs to

The number of this unit in the group. Does not change as units are destroyed

The heading the object is moving to (use `orientation.heading` to get the heading the nose is pointing to).

The horizontal speed of the unit. If it is doing mach one straight up then the speed will be 0

The direction the object is traveling to, and speed (magnitude of the vector) the object is traveling with.

The DCS generated ID

The DCS type-name of the weapon. e.g "Matra_S530D", "HAWK_RAKETA" or "weapons.shells.53-UOR-281U"

The position of the Weapon

The orientation of the unit in both 2D and 3D space

The velocity of the unit in both 2D and 3D space

Latitude in Decimal Degrees format

Longitude in Decimal Degrees format

Altitude in Meters above Mean Sea Level (MSL)

Magnetic declination in degrees. A negative value is an westerly / declination, while a positive value is a easterly declination. `True / North` + `declination` = `Magnetic North`

Whether the response should include only active units (`true`), only inactive units (`false`), or all units (`nil`).

The globally unique ID of the player

The IP address the user had when they were banned

The Name of the player at the time of the ban

The reason given for the ban

When the ban was issued in unixtime

When the ban will expire in unixtime

The session ID of the player

The period of the ban in seconds

The reason for the ban

Was the player successfully banned

The current time in a mission relative to the DCS start time

The slot or unit ID of the unit to retrieve the type of

Type of unit (e.g. "F-14B")

The full path to the .miz file to be loaded

Was the next mission successfully loaded. SHOULD return false when the end of the mission list has been reached but DCS appears to always return true

The globally unique ID of the player

Was the player successfully unbanned

The coalition whose players will be able to see and run the command

The name of the command that is displayed to the player. It will form the last entry in the returned path.

The menu path the command will appear under. This can be empty if you want the command to be on the first level under the F10 menu. This path must already have been created.

A struct containing data that will be included in the emitted event to the DCS-gRPC clients

The full path to the command, including the command name. Use this path to delete the command.

The coalition whose players will be able to see the submenu

The name of the submenu that is displayed to the player. It will form the last entry in the returned path.

The menu path the submenu will appear under. This can be empty if you want the submenu to be on the first level under the F10 menu. This path must already have been created using this command. you cannot create a nested submenu tree in one command.

The full path to the submenu, including the submenu name. Use this path to add another submenu or command underneath it or delete the submenu.

The name of the group whose players will be able to see and execute the command. TODO (Figure out if this persists across spawns)

The name of the command that is displayed to the player. It will form the last entry in the returned path.

The menu path the command will appear under. This can be empty if you want the command to be on the first level under the F10 menu. This path must already have been created.

A struct containing data that will be included in the emitted event to the DCS-gRPC clients

The full path to the command, including the command name. Use this path to delete the command.

The name of the group whose players will be able to see the submenu

The name of the submenu that is displayed to the player. It will form the last entry in the returned path.

The menu path the submenu will appear under. This can be empty if you want the submenu to be on the first level under the F10 menu. This path must already have been created using this command. you cannot create a nested submenu tree in one command.

The full path to the submenu, including the submenu name. Use this path to add another submenu or command underneath it or delete the submenu.

The name of the command that is displayed to the player. It will form the last entry in the returned path.

The menu path the command will appear under. This can be empty if you want the command to be on the first level under the F10 menu. This path must already have been created.

A struct containing data that will be included in the emitted event to the DCS-gRPC clients

The full path to the command, including the command name. Use this path to delete the command.

The name of the submenu that is displayed to the player. It will form the last entry in the returned path.

The menu path the submenu will appear under. This can be empty if you want the submenu to be on the first level under the F10 menu. This path must already have been created using this command. you cannot create a nested submenu tree in one command.

The full path to the submenu, including the submenu name. Use this path to add another submenu or command underneath it or delete the submenu.

The coalition whose players will have the menu item removed

The full path to the menu item, which can be a submenu or a command, to be removed. Deleting a menu item will delete all children it may have.

The group whose players will have the menu item removed

The full path to the menu item, which can be a submenu or a command, to be removed. Deleting a menu item will delete all children it may have.

The full path to the menu item, which can be a submenu or a command, to be removed. Deleting a menu item will delete all children it may have.

The event's mission time.

The following events are additions on top of DCS's own event enum, which is why they start at 8192 to give DCS plenty of space for new built-in events.

The object that captured the base.

The airbase that was captured, can be a FARP or Airbase

The object that was spawned.

The airbase, farp or ship the unit took off from.

The coalition of the player who ran the command

A struct containing details of the command that was run by a player

The player's IP and port.

The name of the player.

The player's unique client identifier (used to ban a player).

The player's id in the current server session (used to for name/slot/... changes).

The object that crashed.

The object that has been destroyed.

The target the failure occurred for.

The ejection seat.

The pilot.

The player's id in the current server session.

The reason a player disconnected for.

The unit a pilot ejected from.

The ejection seat.

Occurs when any aircraft shuts down its engines.

The airbase, farp or ship the unit shut down their engine at.

The object that starts its engines.

The airbase, farp or ship the unit started their engine at.

Details of the group to which the player who ran the command is a unit of

A struct containing details of the command that was run by a player

The object that fired the weapon. Not set when for example fyling an aircraft into a building (building will be the target and weapon_name the name of the aircraft).

The weapon that the target has been hit with.

The object that has been hit.

The weapon the target got hit by.

The unit the system failure occurred in.

The object that fired the weapon.

The weapon that the target has been killed with.

The object that has been killed.

The name of the weapon that killed the target (exists instead of weapon for weapons that trigger the shooting start and end events).

The object that landed.

The airbase, farp or ship the unit landed at.

The ejected pilot.

The position the pilot landed at.

The aircraft that received the rating.

The rating.

The ship the unit landed at.

The object that added the mark.

The group the mark's visibility is restricted for.

The coalition the mark's visibility is restricted for.

The mark's id.

The position the mark has been added at.

The mark's label.

The object that changed the mark.

The group the mark's visibility is restricted for.

The coalition the mark's visibility is restricted for.

The mark's id.

The position of the changed mark.

The mark's label.

The object that removed the mark.

The group the mark's visibility is restricted for.

The coalition the mark's visibility is restricted for.

The mark's id.

The position the mark has been removed from.

The mark's label.

A struct containing details of the command that was run by a player

The unit the pilot has died in.

The player's id in the current server session.

The slot's coalition

The slot's identifier

The unit the player took control of.

The unit the player relieves control of.

The player's id in the current server session.

what was typed

The object that is receiving fuel.

he unit that was receiving fuel.

The object that was shooting and has no stopped firing.

The name of the shoot weapon.

The object that started firing.

The name of the shoot weapon.

The object that fired the weapon.

The weapon that has been fired.

The average FPS since the last event.

The object that took off.

The airbase, farp or ship the unit took off from.

The plain text that got transmitted.

The radio frequency in Hz the transmission got send to.

The coalition of the transmission.

Custom name of the SRS client used for the transmission.

The object that got destroyed weapon.

The object that got spawned.

The name of the payload.

The poll rate in seconds at which the gRPC server communicates with the DCS mission to retrieve the latest unit positions. The lower the `poll_rate` the higher the amount of requests send to to the DCS mission. Default: 5

The maximum backoff in seconds which the gRPC postpones polling units that haven't moved recently. This is an optimization to dynamically reduce the poll rate for stationary units. Set it to the same value as `poll_rate` to disable the backoff. Default: 30

The type of the unit to stream movements. Different categories of units would move at different speeds, which allows the stream to be configured with the appropriate polling rates. `GROUP_CATEGORY_UNSPECIFIED` would return all the units.

The unit is either new or its position or attitude changed.

The unit does not exist anymore.

The current time in seconds since 00:00 of the start date of the mission.

The time in seconds since 00:00.

The altitude of Illumination Bombs is meters above ground. Ground level will be calculated server-side

Altitude parameter will be ignored. Signal flares always fire from ground level which will be calculated server-side

Altitude parameter will be ignored. Smoke always eminates from ground level which will be calculated server-side

Time in seconds since the scenario started.

The position of the unit

The orientation of the unit in both 2D and 3D space

The velocity of the unit in both 2D and 3D space

The text that is synthesized to speech and transmitted to SRS. Supports SSML tags (you should not wrap the text in the root `<speak>` tag though).

The plain text without any transformations made to it for the purpose of getting it spoken out as desired (no SSML tags, no FOUR NINER instead of 49, ...). Even though this field is optional, please consider providing it as it can be used to display the spoken text to players with hearing impairments.

The radio frequency in Hz the transmission is send to. Example: 251000000 for 251.00MHz.

Name of the SRS client. Defaults to "DCS-gRPC".

The origin of the transmission. Relevant if the SRS server has "Line of Sight" and/or "Distance Limit" enabled.

The coalition of the transmission. Relevant if the SRS server has "Secure Coalition Radios" enabled. Only Blue and Red are supported, all other values will fallback to Spectator.

Whether to keep the request open until the whole transmission was sent. If enabled, you can send the next transmission after you've received the response for the previous one and be sure that they don't overlap (talk over each other). If disabled, you'll receive a response right away (kind of fire and forget). You can use the returned duration as a spacing between TTS requests to prevent the overlap of multiple playbacks yourself.