WIP: Custom locations and VECTOR command

Author: dharmab

cmd/skyeye/main.go

@@ -74,6 +74,7 @@ var (
 	discordWebhookID             string
 	discordWebhookToken          string
 	exitAfter                    time.Duration
+	locationsFile                string
 )
 
 func init() {
@@ -142,6 +143,7 @@ func init() {
 	skyeye.Flags().DurationVar(&threatMonitoringInterval, "threat-monitoring-interval", 3*time.Minute, "How often to broadcast THREAT")
 	skyeye.Flags().Float64Var(&mandatoryThreatRadiusNM, "mandatory-threat-radius", 25, "Briefed radius for mandatory THREAT calls, in nautical miles")
 	skyeye.Flags().BoolVar(&threatMonitoringRequiresSRS, "threat-monitoring-requires-srs", true, "Require aircraft to be on SRS to receive THREAT calls. Only useful to disable when debugging")
+	skyeye.Flags().StringVar(&locationsFile, "locations-file", "", "Path to file containing additional locations that may be referenced in ALPHA CHECK and VECTOR calls.")
 
 	// Tracing
 	skyeye.Flags().BoolVar(&enableTracing, "enable-tracing", false, "Enable tracing")

docs/LOCATIONS.md

@@ -0,0 +1,26 @@
+# Custom Locations
+
+Server administrators can define custom locations which players can reference in ALPHA CHECK and VECTOR requests. You can define useful locations like friendly bases or fix points.
+
+To use this feature, create a `locations.json` file. The content of the file should be a JSON array of objects. Each object should have the following properties:
+
+- `names`: An array of strings, which are the names of the location. These names are used in the ALPHA CHECK and VECTOR requests. You can define multiple names for the same location - for example, you might have a location with both the names "Incirlik" and "Home plate"
+- `latitude`: A floating point number, which is the latitude of the location in decimal degrees. This should be a number between -90 and 90.
+- `longitude`: A floating point number, which is the longitude of the location in decimal degrees. This should be a number between -180 and 180.
+
+Example:
+
+```json
+[
+    {
+        "names": ["Incirlik", "Home plate"],
+        "latitude": 37.001166662,
+        "longitude": 35.422164978
+    },
+    {
+        "names": ["Hatay", "Divert option"],
+        "latitude": 36.362778,
+        "longitude": 36.282222
+    }
+]
+```

docs/PLAYER.md

@@ -168,7 +168,7 @@ Tips:
 
 Keyword: `ALPHA`
 
-Function: The GCI will check if they see you on scope and tell you your approximate current location in bullseye format.
+Function: The GCI will check if they see you on scope and tell you your approximate current location as a bearing and range from a given point. You can ask for an Alpha Check from bullseye, or from a [named location](LOCATIONS.md). The bullseye is used if no point is specified.
 
 Use: You can use this to coarsely check your INS navigation system in an aircraft without GPS. It is accurate to within several miles (accounting for potential lag time between when the bot checks the scope and when the response is sent on the radio).
 
@@ -189,6 +189,21 @@ YELLOW 13: "Goliath Yellow One Three alpha"
 GOLIATH: "Yellow One Three, Goliath, contact, alpha check bullseye 088/5"
 ```
 
+### VECTOR
+
+Keyword: `VECTOR`
+
+Function: The GCI will check if you are on scope and tell you the approximate bearing and range from you to a given point. You can ask for a vector to bullseye, or to a [named location](LOCATIONS.md). The bullseye is used if no point is specified.
+
+Use: This is the reciprocal of an ALPHA CHECK, and is useful for navigation assistance.
+
+Examples:
+
+```
+MOBIUS 1: "Thunderhead Mobius One vector to home plate."
+THUNDERHEAD: "Mobius One, Thunderhead, reference 215/55"
+```
+
 ### BOGEY DOPE
 
 Keyword: `BOGEY`

internal/conf/configuration.go

@@ -91,6 +91,8 @@ type Configuration struct {
 	// ThreatMonitoringRequiresSRS controls whether threat calls are issued to aircraft that are not on an SRS frequency. This is mostly
 	// for debugging.
 	ThreatMonitoringRequiresSRS bool
+	// Locations is a slice of named locations that can be referenced in ALPHA CHECK and VECTOR calls.
+	Locations []*Location
 	// EnableTracing controls whether to publish traces
 	EnableTracing bool
 	// DiscordWebhookID is the ID of the Discord webhook
@@ -101,6 +103,13 @@ type Configuration struct {
 	ExitAfter time.Duration
 }
 
+type Location struct {
+	// Names of the location
+	Names []string `json:"names"`
+	// Coordinates of the location as a GeoJSON coordinates array with a single member
+	Coordinates [][]float64 `json:"coordinates"`
+}
+
 var DefaultCallsigns = []string{"Sky Eye", "Thunderhead", "Eagle Eye", "Ghost Eye", "Sky Keeper", "Bandog", "Long Caster", "Galaxy"}
 
 var DefaultPictureRadius = 300 * unit.NauticalMile

pkg/brevity/braa.go

@@ -2,7 +2,6 @@ package brevity
 
 import (
 	"fmt"
-	"math"
 
 	"github.com/dharmab/skyeye/pkg/bearings"
 	"github.com/dharmab/skyeye/pkg/spatial"
@@ -20,20 +19,16 @@ type BRAA interface {
 
 // BRA is an abbreviated form of BRAA without aspect.
 type BRA interface {
-	// Bearing is the heading from the fighter to the contact, rounded to the nearest degree.
-	Bearing() bearings.Bearing
-	// Range is the distance from the fighter to the contact, rounded to the nearest nautical mile.
-	Range() unit.Length
+	Vector
 	// Altitude of the contact above sea level, rounded to the nearest thousands of feet.
 	Altitude() unit.Length
 	// Altitude STACKS of the contact above sea level, rounded to the nearest thousands of feet.
 	Stacks() []Stack
 }
 
 type bra struct {
-	bearing bearings.Bearing
-	_range  unit.Length
-	stacks  []Stack
+	vector
+	stacks []Stack
 }
 
 // NewBRA creates a new [BRA].
@@ -42,22 +37,14 @@ func NewBRA(b bearings.Bearing, r unit.Length, a ...unit.Length) BRA {
 		log.Warn().Stringer("bearing", b).Msg("bearing provided to NewBRA should be magnetic")
 	}
 	return &bra{
-		bearing: b,
-		_range:  r,
-		stacks:  Stacks(a...),
+		vector: vector{
+			bearing:  b,
+			distance: r,
+		},
+		stacks: Stacks(a...),
 	}
 }
 
-// Bearing implements [BRA.Bearing].
-func (b *bra) Bearing() bearings.Bearing {
-	return b.bearing
-}
-
-// Range implements [BRA.Range].
-func (b *bra) Range() unit.Length {
-	return unit.Length(math.Round(b._range.NauticalMiles())) * unit.NauticalMile
-}
-
 // Altitude implements [BRA.Altitude].
 func (b *bra) Altitude() unit.Length {
 	if len(b.stacks) == 0 {

pkg/brevity/bullseye.go

@@ -2,7 +2,6 @@ package brevity
 
 import (
 	"fmt"
-	"math"
 
 	"github.com/dharmab/skyeye/pkg/bearings"
 	"github.com/martinlindhe/unit"
@@ -11,32 +10,38 @@ import (
 
 // Bullseye is a magnetic bearing and distance from a reference point called the BULLSEYE.
 // Reference: ATP 3-52.4 Chapter IV section 4 subsection a.
-type Bullseye struct {
-	bearing  bearings.Bearing
-	distance unit.Length
+type Bullseye interface {
+	Bearing() bearings.Bearing
+	Distance() unit.Length
+}
+
+type bullseye struct {
+	vector
 }
 
 // NewBullseye creates a new [Bullseye].
-func NewBullseye(bearing bearings.Bearing, distance unit.Length) *Bullseye {
+func NewBullseye(bearing bearings.Bearing, distance unit.Length) Bullseye {
 	if !bearing.IsMagnetic() {
 		log.Warn().Stringer("bearing", bearing).Msg("bearing provided to NewBullseye should be magnetic")
 	}
-	return &Bullseye{
-		bearing:  bearing,
-		distance: distance,
+	return &bullseye{
+		vector: vector{
+			bearing:  bearing,
+			distance: distance,
+		},
 	}
 }
 
 // Bearing from the BULLSEYE to the contact, rounded to the nearest degree.
-func (b *Bullseye) Bearing() bearings.Bearing {
-	return b.bearing
+func (b *bullseye) Bearing() bearings.Bearing {
+	return b.Bearing()
 }
 
 // Distance from the BULLSEYE to the contact, rounded to the nearest nautical mile.
-func (b *Bullseye) Distance() unit.Length {
-	return unit.Length(math.Round(b.distance.NauticalMiles())) * unit.NauticalMile
+func (b *bullseye) Distance() unit.Length {
+	return b.Range()
 }
 
-func (b *Bullseye) String() string {
-	return fmt.Sprintf("%s/%.0f", b.bearing, b.distance.NauticalMiles())
+func (b *bullseye) String() string {
+	return fmt.Sprintf("%s/%.0f", b.Bearing(), b.Distance().NauticalMiles())
 }

pkg/brevity/declare.go

@@ -75,7 +75,7 @@ func (r DeclareRequest) String() string {
 			s += fmt.Sprintf(", altitude %.0f", r.Altitude.Feet())
 		}
 	} else {
-		s += fmt.Sprintf("bullseye %s", &r.Bullseye)
+		s += fmt.Sprintf("bullseye %s", r.Bullseye)
 	}
 	if r.Track != UnknownDirection {
 		s += fmt.Sprintf(", track %s", r.Track)

pkg/brevity/group.go

@@ -19,7 +19,7 @@ type Group interface {
 	// Contacts is the number of contacts in the group.
 	Contacts() int
 	// Bullseye is the location of the group. This may be nil for BOGEY DOPE, SNAPLOCK, and THREAT calls.
-	Bullseye() *Bullseye
+	Bullseye() Bullseye
 	// Altitude is the group's highest altitude. This may be zero for BOGEY DOPE, SNAPLOCK, and THREAT calls.
 	Altitude() unit.Length
 	// Stacks are the group's altitude STACKS, ordered from highest to lowest in intervals of at least 10,000 feet.

pkg/brevity/vector.go

@@ -0,0 +1,55 @@
+package brevity
+
+import (
+	"math"
+
+	"github.com/dharmab/skyeye/pkg/bearings"
+	"github.com/martinlindhe/unit"
+)
+
+type Vector interface {
+	// Bearing is the heading from the fighter to the target location, rounded to the nearest degree.
+	Bearing() bearings.Bearing
+	// Range is the distance from the fighter to the target location, rounded to the nearest nautical mile.
+	Range() unit.Length
+}
+
+type vector struct {
+	bearing  bearings.Bearing
+	distance unit.Length
+}
+
+// Bearing implements [Vector.Bearing].
+func (v *vector) Bearing() bearings.Bearing {
+	return v.bearing
+}
+
+// Range implements [Vector.Range].
+func (v *vector) Range() unit.Length {
+	return unit.Length(math.Round(v.distance.NauticalMiles())) * unit.NauticalMile
+}
+
+type VectorRequest struct {
+	// Callsign of the friendly aircraft requesting the vector.
+	Callsign string
+	//  Location to which the friendly aircraft is requesting a vector.
+	Location string
+}
+
+func (r VectorRequest) String() string {
+	return "VECTOR to " + r.Location + " for " + r.Callsign
+}
+
+type VectorResponse struct {
+	// Callsign of the friendly aircraft requesting the vector.
+	Callsign string
+	// Location which the friendly aircraft is requesting a vector.
+	Location string
+	// Contact is true if the callsign was correlated to an aircraft on frequency, otherwise false.
+	Contact bool
+	// Status is true if the vector was successfully computed, otherwise false.
+	Status bool
+	// Vector is the computed vector to the target location, if available.
+	// // If Status is false, this may be nil.
+	Vector Vector
+}

pkg/composer/faded.go

@@ -14,7 +14,7 @@ func (c *Composer) ComposeFadedCall(call brevity.FadedCall) (response NaturalLan
 	}
 
 	if bullseye := call.Group.Bullseye(); bullseye != nil {
-		bullseye := c.composeBullseye(*bullseye)
+		bullseye := c.composeBullseye(bullseye)
 		response.WriteResponse(bullseye)
 	}