Jump to content
Main menu
Main menu
move to sidebar
hide
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
SimTX Wiki
Search
Search
Appearance
Create account
Log in
Personal tools
Create account
Log in
Pages for logged out editors
learn more
Contributions
Talk
Editing
SimTX API
(section)
Page
Discussion
English
Read
Edit
Edit source
View history
Tools
Tools
move to sidebar
hide
Actions
Read
Edit
Edit source
View history
General
What links here
Related changes
Special pages
Page information
Appearance
move to sidebar
hide
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Reference pages == === Account service === * [[SimTX API/Account service]]: base URL, authentication, credential formats, errors and rate limits. * [[SimTX API/Device login]]: signing a user in from a desktop or command-line program. * [[SimTX API/Server directory]]: discovering game servers and their features. * [[SimTX API/Station endpoints]]: creating and editing stations, launching and deorbiting satellites. * [[SimTX API/Game tickets]]: exchanging a credential for a one-shot game server ticket, optionally bound to a station. * [[SimTX API/Permissions]]: scopes, permission identifiers and numeric capabilities. * [[SimTX API/Public endpoints]]: status, public satellites, profiles, releases and network test. === Game protocol === * [[SimTX API/Connection and handshake]]: TLS, the preface, the hello, roles and hello results. * [[SimTX API/Framing]]: length-delimited frames, size limits and skipping unknown frames. * [[SimTX API/Data types]]: protobuf types, conventions and shared messages. * [[SimTX API/Session status]]: how receiver and transmitter sessions are bound, updated, refused and ended. * [[SimTX API/Receiver session]]: requesting a receiver and decoding IQ. * [[SimTX API/Transmitter session]]: admission, streaming samples, live updates and telemetry. * [[SimTX API/Control session]]: station list, banners, health, coverage and weather maps, ephemerides, passes, monitoring. * [[SimTX API/Extension catalog protocol]]: listing, fetching, uploading and deleting catalog entries. * [[SimTX API/Moderation session]]: moderator tools. Not usable without moderator permission. * [[SimTX API/Limits and errors]]: the error model, session limits, rate limits and timeouts. * [[SimTX API/Compatibility and versioning]]: protocol revisions, the feature registry and what may change. * [[SimTX API/Packet list]]: every frame member in both directions. * [[SimTX API/Schema]]: the <code>.proto</code> files. === Stations and satellites === * [[SimTX API/Stations]]: persistent stations, station-bound and ad-hoc sessions, what the station dictates. * [[SimTX API/Satellites]]: user-launched satellites, the orbit model, ephemerides, passes and deorbiting. * [[SimTX API/Tracking and pointing]]: steerable antennas, rotators and Doppler correction.
Summary:
Please note that all contributions to SimTX Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
SimTX Wiki:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)