Jump to content

Main Page: Difference between revisions

From SimTX Wiki
Clanker (talk | contribs)
Point the developer line at the protocol v25 reference
Clanker (talk | contribs)
Show getting started, the user guides and the API reference first
Line 5: Line 5:
'''SimTX is a shared radio simulation.''' Set up a virtual transmitter, send audio, and listen with a receiver. No physical radio or antenna is needed. Distance, antennas, and radio conditions affect what listeners hear.
'''SimTX is a shared radio simulation.''' Set up a virtual transmitter, send audio, and listen with a receiver. No physical radio or antenna is needed. Distance, antennas, and radio conditions affect what listeners hear.


<span style="font-size:125%;">'''[[Getting Started|Download SimTX and make your first transmission]]'''</span>
</div>
 
== Getting started ==
'''[[Getting Started|Install SimTX and make your first transmission]]'''. The guide covers installation, sign-in, choosing a server, your first station, a first transmission and listening.
 
== User guides ==
How the main parts of the desktop app work, step by step:
* '''[[SimTX Guide/Stations|Stations]]''': the place you transmit and receive from, with its antennas and radios.
* '''[[SimTX Guide/Satellites|Satellites]]''': design and launch your own satellite, follow its passes, and deorbit it.
* '''[[SimTX Guide/Rotators and tracking|Rotators and tracking]]''': turn an antenna by hand or let it follow a satellite.
All guides are listed on [[SimTX Guide]].


The illustrated guide covers installation, account sign-in, server selection, a working example, listening, and saving your settings.
== For developers ==
</div>
The [[SimTX API]] reference documents the account service and the game protocol, message by message. Start with the [[SimTX API/Quick start|quick start]].


== Learn in order ==
== Learn in order ==
# '''[[Getting Started|Download and transmit]]''': follow one complete example from an empty desktop to your first TX session.
# '''[[Getting Started|Install and transmit]]''': follow one complete example from an empty desktop to your first TX session.
# '''[[Transmitter Interface|Find your way around]]''': identify the controls and understand the meters.
# '''[[Transmitter Interface|Find your way around]]''': identify the controls and understand the meters.
# '''[[Transmission Sources|Choose what to send]]''': play a file, use a microphone, or send a stream.
# '''[[Transmission Sources|Choose what to send]]''': play a file, use a microphone, or send a stream.
Line 18: Line 28:
# [[How to receive|'''Start to receiving''']]: receiving signals and stations using any [[wikipedia:Software-defined_radio|SDR]] app.
# [[How to receive|'''Start to receiving''']]: receiving signals and stations using any [[wikipedia:Software-defined_radio|SDR]] app.


[[File:SimTX-0.3.6-first-transmission-guide-clean.png|thumb|center|850px|alt=Annotated SimTX Transmitter window showing station settings, radio settings, audio source, antenna, Start TX, and session controls.|The transmitter window. The guide explains each marked area.]]
[[File:SimTX-0.3.6-first-transmission-guide-clean.png|thumb|center|850px|alt=Annotated window of the older Java transmitter showing station settings, radio settings, audio source, antenna, Start TX, and session controls.|The older Java transmitter (version 0.3.6).]]


== Find a specific answer ==
== Find a specific answer ==
Line 26: Line 36:
* '''What do SWR, bandwidth, and IQ mean?''' See [[Radio terms]].
* '''What do SWR, bandwidth, and IQ mean?''' See [[Radio terms]].
* '''Looking for formulas or an API?''' Open the [[Documentation|complete documentation index]], including antenna calculations and every Lua API reference.
* '''Looking for formulas or an API?''' Open the [[Documentation|complete documentation index]], including antenna calculations and every Lua API reference.
* '''Writing your own software?''' The [[SimTX API]] reference documents the account service and the game protocol, message by message. Start with the [[SimTX API/Quick start|quick start]].


== Community and other ways to use SimTX ==
== Community and other ways to use SimTX ==
* [[:Category:Radio Stations|Community radio stations]]: stations described by their operators.
* [[:Category:Radio Stations|Community radio stations]]: stations described by their operators.
* [[Guide to setting up sdr console with simtx|SDR Console]], [[DATV RX Tutorial|digital television reception]], [[DATV TX Tutorial|digital television transmission]], [[How to receive]] and [[DRM TX tutorial|DRM transmission]]: additional community guides.
* [[Guide to setting up sdr console with simtx|SDR Console]], [[DATV RX Tutorial|digital television reception]], [[DATV TX Tutorial|digital television transmission]], [[How to receive]] and [[DRM TX tutorial|DRM transmission]]: additional community guides.
* [https://simtx.net/downloads Download the transmitter] · [https://simtx.net SimTX website] · [https://discord.gg/BxtpFJAs6c SimTX Discord]
* [[Getting Started#1. Install the app|Download the desktop app]]
* [https://simtx.net/downloads Download the Java transmitter]
* [https://simtx.net SimTX website]
* [https://discord.gg/BxtpFJAs6c SimTX Discord]

Revision as of 19:42, 24 October 2026

SimTX Wiki

SimTX is a shared radio simulation. Set up a virtual transmitter, send audio, and listen with a receiver. No physical radio or antenna is needed. Distance, antennas, and radio conditions affect what listeners hear.

Getting started

Install SimTX and make your first transmission. The guide covers installation, sign-in, choosing a server, your first station, a first transmission and listening.

User guides

How the main parts of the desktop app work, step by step:

  • Stations: the place you transmit and receive from, with its antennas and radios.
  • Satellites: design and launch your own satellite, follow its passes, and deorbit it.
  • Rotators and tracking: turn an antenna by hand or let it follow a satellite.

All guides are listed on SimTX Guide.

For developers

The SimTX API reference documents the account service and the game protocol, message by message. Start with the quick start.

Learn in order

  1. Install and transmit: follow one complete example from an empty desktop to your first TX session.
  2. Find your way around: identify the controls and understand the meters.
  3. Choose what to send: play a file, use a microphone, or send a stream.
  4. Change frequency and coverage: choose and adjust an antenna, then learn why reception changes.
  5. Add features: install modes, audio processors, tools, and themes without writing code.
  6. Start to receiving: receiving signals and stations using any SDR app.
Annotated window of the older Java transmitter showing station settings, radio settings, audio source, antenna, Start TX, and session controls.
The older Java transmitter (version 0.3.6).

Find a specific answer

Community and other ways to use SimTX