{"id":24612715,"url":"https://github.com/viralpickaxe/xplane-udp","last_synced_at":"2025-09-17T10:06:14.195Z","repository":{"id":57402109,"uuid":"88066687","full_name":"viralpickaxe/xplane-udp","owner":"viralpickaxe","description":"XPlane UDP Client for Node.js","archived":false,"fork":false,"pushed_at":"2017-05-01T15:35:18.000Z","size":26,"stargazers_count":15,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T14:32:31.255Z","etag":null,"topics":["flight-simulator","library","typescript","udp"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/xplane-udp","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/viralpickaxe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-12T15:19:06.000Z","updated_at":"2025-02-05T22:18:14.000Z","dependencies_parsed_at":"2022-09-15T18:40:47.851Z","dependency_job_id":null,"html_url":"https://github.com/viralpickaxe/xplane-udp","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viralpickaxe%2Fxplane-udp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viralpickaxe%2Fxplane-udp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viralpickaxe%2Fxplane-udp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viralpickaxe%2Fxplane-udp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viralpickaxe","download_url":"https://codeload.github.com/viralpickaxe/xplane-udp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252776480,"owners_count":21802462,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flight-simulator","library","typescript","udp"],"created_at":"2025-01-24T20:25:07.771Z","updated_at":"2025-09-17T10:06:09.137Z","avatar_url":"https://github.com/viralpickaxe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XPlane UDP [![Build Status](https://travis-ci.org/viralpickaxe/xplane-udp.svg?branch=master)](https://travis-ci.org/viralpickaxe/xplane-udp)\nXPlane UDP Client for Node.js\n\n## Requirements\n- NodeJS (v6.X.X)\n- Xplane 11\n\n## Usage\n```javascript\n// Import XPlane class from the package\nimport { XPlaneClient } from \"xplane-udp\"\n\n\n// Create a client on a specific port (this is a value you define in your xplane game settings)\nconst client = new XPlaneClient(49000)\n\n// Start the UDP listener\nclient.start()\n\n// Subscribe to the updated event\n// This will fire at the rate at which you send UDP updates (set in-game)\nclient.on(\"updated\", (data) =\u003e {\n    \n    // Do something with the data\n    console.log(data)\n\n})\n\n// You can also access the data directly from the client instance\ncallMeMaybe(() =\u003e {\n    \n    // Access data in the following format `\u003cclient\u003e.data.\u003cgroup\u003e.\u003cvalue\u003e`\n    console.log(client.data.time.real)\n    console.log(client.data.airspeed.indicated)\n\n})\n\n```\n\n## Output Data Format (XPlaneUpdate interface)\n\nBelow is the structure of the data object returned in the `updated` event, or otherwise accesible directly from `client.data.\u003cgroup\u003e.\u003cvalue\u003e`.\n\n- `time`\n  - `real` - [s]\n  - `total` - [s]\n  - `mission` - [s]\n  - `timer` - [s]\n  - `zulu` - [hh.ss]\n  - `local` - [hh.ss]\n  - `hobbs`\n- `airspeed`\n  - `indicated` - KIAS [kts]\n  - `equivalent` - KEAS [kts]\n  - `true` - KTAS [kts]\n  - `truegnd` - KTGS [kts]\n  - `mph` - IAS [mph]\n  - `mphair` - [mph]\n  - `mphgnd` - [mph]\n- `gload`\n  - `mach` - Mach number [ratio]\n  - `vvi` - VVI [fpm]\n  - `normal`\n  - `axial`\n  - `side`\n- `angularmoment`\n  - `m` - [ftlb]\n  - `l` - [ftlb]\n  - `n` - [ftlb]\n- `angularvelocity`\n  - `q` - [rad/s]\n  - `p` - [rad/s]\n  - `r` - [rad/s]\n- `attitude`\n  - `pitch` - [deg]\n  - `roll` - [deg]\n  - `truehdg` - [deg]\n  - `maghdg` - [deg]\n- `aoa`\n  - `alpha` - [deg]\n  - `beta` - [deg]\n  - `hpath` - [deg]\n  - `vpath` - [deg]\n  - `slip` - [deg]\n- `compass`\n  - `mag` - [comp]\n  - `mavar` - [deg]\n- `globalposition`\n  - `lat` - [deg]\n  - `lon` - [deg]\n  - `altmsl` - [ft]\n  - `altagl` - [ft]\n  - `runway` - [runway no.]\n  - `altind` - [ft]\n  - `latnorm`\n  - `lonnorm`\n- `simposition`\n  - `x` - [m]\n  - `y` - [m]\n  - `z` - [m]\n  - `vx` - [m/s]\n  - `vy` - [m/s]\n  - `vz` - [m/s]\n  - `distft` - [ft]\n  - `distnm` - [nm]\n- `throttlecommand`\n  - `[1..8]`\n- `throttleactual`\n  - `[1..8]`\n- `enginepower`\n  - `[1..8]` - [hp]\n- `enginethrust`\n  - `[1..8]`\n- `enginetorque`\n  - `[1..8]`\n- `enginerpm`\n  - `[1..8]`\n- `proprpm`\n  - `[1..8]`\n- `proppitch`\n  - `[1..8]`\n- `enginewash` - propwash or jetwash\n  - `[1..8]` - [kts]\n- `n1` - turbine N1 %\n  - `[1..8]` - [%]\n- `n2` - turbine N2 %\n  - `[1..8]` - [%]\n- `fuelflow`\n  - `[1..8]` - [lb/h]\n- `itt`\n  - `[1..8]` - [deg]\n- `egt`\n  - `[1..8]` - [deg]\n- `cht`\n  - `[1..8]` - [deg]\n- `oilpressure`\n  - `[1..8]` - [psi]\n- `oiltemp`\n  - `[1..8]` - [deg]\n- `fuelpressure`\n  - `[1..8]` - [psi]\n- `aeroforce`\n  - `lift` - [lb]\n  - `drag` - [lb]\n  - `side` - [lb]\n- `engineforce`\n  - `normal` - [lb]\n  - `axial` - [lb]\n  - `side` - [lb]\n\n## Contibute to the code\n1. Clone the Repo onto your local machine\n2. Install the dependancies: `npm i`\n3. Build the code (ts-\u003ejs): `npm run typescript` (or `typescript-watch` to watch)\n4. Contribute!\n\n## Running the tests\n1. Clone the Repo onto your local machine\n2. Install the dependancies: `npm i`\n3. Build the code (ts-\u003ejs): `npm run typescript`\n4. Run the tests: `npm run test`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviralpickaxe%2Fxplane-udp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviralpickaxe%2Fxplane-udp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviralpickaxe%2Fxplane-udp/lists"}