README.md

NAME

   my_radar

SYNOPSIS

   Air traffic simulation panel

DESCRIPTION

   ./my_radar [OPTIONS] path_to_script.    path_to_script: The path to the script file.

   OPTIONS     -h
     display the help

    -R

     disable sprite rotation

    -L

     start the simulation with hitboxes and areas disabled

    -S

     start the simulation with sprites disabled

    -B

     start the simulation with background disable

    -G

     start the simation with the grid enable

    -M [VALUE]

     start the simulation with a given speed

      the VALUE as to be a positive integer between 1 and 4

      the default value is set to 1

   EXIT STATUS

    0 Successful program execution,

    1 Usage, syntax or file error.

USER INTERACTIONS

   'L' key: enable/disable hitboxes and areas
   'S' key: enable/disable sprites
   'B' key: enable/disable background
   'G' key: enable/disable grid
   'Q' key: close the window
   'SPACE' key: play/pause the simulation
   'up_arrow' key: increase speed
   'down_arrow' key: decrease speed
   'right_arrow' reset speed to 1

SCRIPT FORMAT

   The script file describe the plane and the tower to use inside the program.

   The script has no limit in terms of object describe, but as to be written the following way:

   ""A <start position X (Px)> <start position Y (Px)> <end position X (Px)> <end position Y (Px)> <speed int (Px/s)> <time before take off (s)>""

   OR

   "T <position X (Px)> <position Y (Px)> <radius (%)>"

   All the value describe are positive integers

   ALL those value are in pixel, except for:

• : pixel per second
  
• : second
  
• : percentage of the window size
  

EXAMPLE

   ./my_radar -h    ./my_radar scripts/scripts.rdr

REPORTING BUG

   There is no bug