GET /api/settings
Returns every numeric script setting as a flat key-value JSON object. Useful for snapshotting the current configuration before tweaking it, or for syncing an external UI to the AimForge GUI state.
Request
GET /api/settings HTTP/1.1
Host: localhost:4242
No request body, no query parameters.
Response
200 OK
{
"sensitivity": 0.10,
"fov": 560.0,
"delay": 35.0
}
The keys are the exact var= names declared in your script's //!gui:* directives. The values are the current scalar values (after any user adjustments via the GUI or previous PATCH calls).
What's included
| Setting type | Returned? |
|---|---|
Numeric (slider, number) |
✅ Yes |
Boolean (checkbox) — stored as 0/1 |
✅ Yes |
| Dropdown — stored as selected index | ✅ Yes |
Colour picker — string "#RRGGBB" |
❌ No (non-numeric) |
| Text input | ❌ No (non-numeric) |
| Charts, regions, lists | ❌ No (complex types) |
Only numeric scalars are returned. Strings, colours, and complex types are excluded from this endpoint by design.
Examples
curl
curl http://localhost:4242/api/settings
JavaScript
const res = await fetch('http://localhost:4242/api/settings');
const settings = await res.json();
console.log(`Current FOV: ${settings.fov}`);
PowerShell
Invoke-RestMethod -Uri http://localhost:4242/api/settings | ConvertTo-Json
See also
- PATCH /api/settings — to update one or more settings
- GUI directives — how settings keys are declared in your scripts