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 terrain module in Retribution.

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.

pydcs export
1. Export latest DCS data
2. airport_import.py
3. coord_export.lua
4. export_map_projection.py
5. Send PR to pydcs
6. Update Retribution to the latest DCS
Add beacons for the new terrain
1. The beacons file can be generated by running resources/tools/import_beacons.py
2. The beacons file needs to be added to resources/dcs/beacons/NAME_OF_TERRAIN.json
3. You can use the existing files as a reference/template to ensure the correct output
Add the terrain info to resources/theaters/NAME_OF_TERRAIN/info.yaml
Add the terrain icon to resources/theaters/NAME_OF_TERRAIN/icon.gif
1. This icon will be used only as a fallback. By default, Retribution uses the icon from the user's DCS installation. However, the DCS installation will only have this icon in case the terrain in question is installed. The fallback is needed in order for icons to be displayed on all terrains, including the ones which the user might not own or have installed.
Generate terrain landmap
- Option 1: Define sea zones, inclusion zones, exclusion zones in the mission editor.
  1. Exclusion zones are defined by the waypoints of USA F-15C plane groups
  2. Inclusion zones are defined by the waypoints of any other USA plane groups
  3. Sea zones are defined by the waypoints of USA ship groups
  4. After the mission is completed and saved in the correct folder (resources/tools/NAME_OF_TERRAIN_terrain.miz), update resources/tools/generate_landmap.py with the name of the new terrain and run it.
- Option 2: Generate the zones from GIS data
  1. Creating shape files in QGIS for map data
  2. Once GIS maps have been added to unshipped_data/arcgis_maps, run resources/tools/arcgis_landmap_import.py