Plugin format
The .sfplugin file, field by field: the wrapper, airports, airlines and themes, with every limit the game checks.
A .sfplugin file is plain JSON (UTF-8), up to 2 MB. One plugin can hold up to 20 airports, 60 airlines and 10 themes. The easiest way to get a correct airport is to build it in the Airport Editor and export it; this page is for writing or editing files by hand.
#The wrapper
{
"format": "shortfinal-plugin",
"formatVersion": 1,
"id": "com.yourname.saltmarsh",
"name": "Saltmarsh International",
"version": "1.0.0",
"author": "Your name",
"description": "A coastal airport with parallel runways.",
"contents": {
"airports": [ ... ],
"airlines": [ ... ],
"themes": [ ... ]
}
}
| Field | Required | Rules |
format | Yes | Exactly "shortfinal-plugin" |
formatVersion | Yes | 1 |
id | Yes | Lowercase, reverse-domain style, unique to your plugin: com.yourname.pluginname. Up to 80 characters |
name | Yes | Up to 60 characters |
version | Yes | Like 1.0 or 1.0.0. Installing a plugin with the same id replaces the old version |
author | No | Up to 60 characters |
description | No | Up to 600 characters |
contents | Yes | At least one airport, airline or theme |
#Coordinates
Positions are in nautical miles from the airport's centre: x is east (negative = west), y is south (negative = north). So [0, -20] is 20 nm north. Headings are degrees true, 0–360.
#Airports
{
"id": "smi",
"name": "Saltmarsh International",
"code": "SMI",
"icao": "EGXX",
"difficulty": 3,
"blurb": "Parallel runways on the coast.",
"radius": 32,
"arrInterval": 100,
"depInterval": 110,
"exitAlt": 8000,
"transAlt": 6000,
"runways": [
{ "c": [0, -0.6], "hdg": 240, "len": 1.7, "names": ["06R", "24L"], "use": "arr" },
{ "c": [0, 0.6], "hdg": 240, "len": 1.6, "names": ["06L", "24R"], "use": "dep" }
],
"fixes": [
{ "name": "GANET", "x": -24, "y": -19, "type": "entry" },
{ "name": "WHELK", "x": -11, "y": -9, "type": "iaf" },
{ "name": "SKATE", "x": 30, "y": 9, "type": "exit" }
],
"entries": [ { "fix": "GANET", "via": "WHELK" } ],
"exits": ["SKATE"],
"noIls": ["06L"],
"missed": { "24L": { "fix": "WHELK", "alt": 3000 } },
"apron": [0.9, 1.4],
"restricted": [ { "name": "D201", "x": 18, "y": 20, "r": 4, "hi": 6000 } ],
"traffic": { "EZY": 10, "RYR": 8, "BAW": 4 },
"map": {
"water": [ [[-40, 10], [40, 12], [40, 40], [-40, 40]] ],
"rivers": [ [[-20, -5], [-8, -2], [0, 3]] ],
"hills": [ { "x": -15, "y": -25, "r": 5 }, { "x": 10, "y": -20, "r": 3, "msa": 4000 } ],
"towns": [ { "name": "Saltmarsh", "x": 4, "y": 6 } ],
"airfields": [ { "name": "Gull Point", "x": 20, "y": -12 } ]
}
}
#Airport fields
| Field | Required | Rules |
id | Yes | Letters, numbers, - or _, up to 24. Unique within your plugin |
name | Yes | Up to 60 characters |
code | No | Short code shown on the map |
icao | No | 4 capital letters. Used for live weather |
difficulty | No | 1–5 |
blurb, region | No | Shown on the menu |
radius | Yes | 15–60 nm |
arrInterval, depInterval | Yes | 20–900 seconds between arrivals / departures at normal traffic |
exitAlt | No | 3,000–16,000 ft. Default 9,000 |
transAlt | No | 3,000–18,000 ft. Default 6,000 |
runways | Yes | 1–6, see below. At least one open for landings and one for departures; no two ends with the same name |
fixes | Yes | Up to 80, see below |
entries | Yes | At least one { "fix", "via" }: fix is an entry fix; via is the fix it feeds into (usually an iaf) |
exits | Yes | At least one name of an exit fix |
noIls | No | Runway end names with no ILS |
missed | No | Runway end name → { "fix", "alt" }: an existing fix, altitude 1,500–8,000 ft |
apron | No | [x, y] within 20 nm. Worked out automatically if missing |
restricted | No | Up to 20 { "name" (≤8 chars), "x", "y", "r" (0.5–15), "hi" (1,000–20,000 ft) } |
traffic | No | Airline code → weight 0–100. Codes are 3 capital letters. Leave it out for the standard European mix |
map | No | Scenery, see below |
#Runways
| Field | Rules |
c | [x, y] of the runway's middle, inside the airspace |
hdg | Heading of the first end, 0–360 |
len | Length in nm, 0.3–3.5 (1 nm = 1,852 m) |
names | Two end names, like ["09", "27"] or ["04L", "22R"]. The first goes with hdg, the second with the opposite direction |
use | both (default), arr, dep or off (drawn but never used) |
#Fixes
| Field | Rules |
name | 2–8 capital letters or numbers, unique |
x, y | Within the airspace (up to 5 nm beyond the edge) |
type | entry (arrivals appear here), iaf (holding / feeder fix) or exit (departures leave here) |
STARs and SIDs are generated from your entries and exits; you don't define them.
#Scenery (map)
| Field | Rules |
water | Up to 40 polygons, each a list of 2–200 [x, y] points (coordinates up to ±200 nm, so the sea can run off the map) |
rivers | Up to 40 lines, each 2–200 points |
hills | Up to 40 { "x", "y", "r" (0.5–15), "msa" (optional, 0–16,000 ft) } |
towns | Up to 60 { "name" (≤40), "x", "y" } |
airfields | { "name" (≤40), "x", "y" } |
#Airlines
"airlines": [
{ "code": "LOG", "call": "Logan", "name": "Loganair", "types": ["AT76", "E195"], "weight": 10, "airports": ["*"] },
{ "code": "FDX", "call": "FedEx", "name": "FedEx Express", "types": ["B763", "B77W"], "weight": 3, "airports": ["LHR", "STN"] }
]
| Field | Rules |
code | 3 capital letters (the ICAO airline code; the callsign's prefix) |
call | The radio callsign the pilots use, up to 30 characters (“Speedbird”, “Logan”) |
name | Up to 50 characters |
types | At least one of: A319 A320 A20N A21N A333 A359 A35K A388 AT76 B38M B738 B763 B772 B77W B789 CRJ9 DH8D E190 E195 |
weight | 0–100, how often it appears. Default 5 |
airports | ["*"] for everywhere, or a list of airport ids (built-in ids like LHR, or ones from your plugin) |
#Themes
"themes": [ {
"id": "blueprint", "name": "Blueprint", "base": "night",
"radar": { "bg": "#123d66", "ink": "#eef4fb", "runway": "#eef4fb", "arr": "#7fd1ff", "dep": "#ffd166" },
"ui": { "--bg": "#123d66", "--panel": "#16466f", "--ink": "#eef4fb" }
} ]
| Field | Rules |
id | Lowercase letters, numbers or -, up to 30 |
name | Up to 40 characters. Shown in Settings → Look |
base | paper or night: anything you don't set comes from this |
radar | Any of: bg grid water waterLine hill river town ink muted ring boundary runway centre fix arr dep sel red amber label hold trail |
ui | Any of: --bg --panel --panel2 --strip --ink --muted --line --arr --dep --sel --red --amber --ok --btn --btnh |
Colours are #rgb, #rrggbb, #rrggbbaa, rgb(…) or rgba(…).
#Checking your file
Drag it onto the game window. If anything's wrong, the game lists up to 25 problems with exactly what to fix (for example “Airport Saltmarsh: entry GANET: "feeds into" fix WHELK doesn't exist”) and installs nothing.