dcs-retribution

mirror of https://github.com/dcs-retribution/dcs-retribution.git synced 2025-11-10 15:41:24 +00:00

This checklist describes the work needed to add support for a new aircraft module in Retribution. The same steps apply to both official modules and mods, though mods are often held to a lower standard.

The content below the line can be copied into the FR for tracking the work. Copy the source rather than the rendered view to preserve formatting in the bug. Mods should replace the first task (pydcs export) with the instructions in Modded aircraft support.

The tasks below are rated P0-P2 to indicate their importance:

Priority	Description
P0	Required. Module will not function in Retribution without completing these tasks. Must be addressed before shipping in a release.
P1	Most modules complete these tasks. Commonly available features will not be available for the module if these tasks are skipped. Expect bug reports. Should be addressed before shipping in a release.
P2	Many modules don't complete these tasks. Completing these tasks is required for complete functionality. Can be addressed in future releases.

P0: pydcs export
1. Export latest DCS data by following the instructions at the top of pydcs_export.lua
2. Send PR to pydcs
3. Update Retribution to the latest DCS
P0: Add unit data to resources/units/aircraft. See the F-16C data for a complete example.
- P0: Price. Compare to similar aircraft to determine what the price should be.
- P0: Variants. These are the names that will be used in the UI. At least one is required, but variants should be added for faction-specific types as necessary (e.g. a CF-18 variant for the Canadian F/A-18).
- P1: Maximum range estimate. This is the maximum range from departure to target that the auto-planner will consider. The defaults are extremely conservative to avoid planning missions that will kill AI flights that run out of fuel.
- P1: Information sections (description, introduction date, manufacturer, origin, and role).
- P1: Radio configuration. See radios.py for a list of known radio types. Add new radios to that list if necessary. Necessary for default channel assignments and non-conflicting intra-flight frequency assignments.
- P2: Fuel consumption data. Without this the kneeboard will not show minimum required fuel for each waypoint, and bingo/joker estimates may be extremely inaccurate.
P0: Flight planner priority lists. These lists are in priority order. Add the aircraft to the list for each mission type it is capable of in the order suitable for auto-planner preference. For example, for CAP the F-16 should be lower in the list than the F-22, but above the FW-190.
P0: Default loadouts for all supported mission types.
P0: Add to relevant factions.
P0: Aircraft specific waypoint behavior. Most aircraft, such as those capable of a large (20+) quantity of waypoints or have no built-in waypoint navigation do not need custom behavior. Aircraft like the Viggen and F-14 where waypoints are constrained and/or have specific meanings will need to complete this task.
P1: Banners/icons.