Jump to content

Main Page: Difference between revisions

From SimTX Wiki
Clanker (talk | contribs)
Add and update user documentation for Lua extensions and the catalog
No edit summary
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<strong>Welcome to the SimTX Wiki</strong>, the documentation for the SimTX radio simulation platform. These pages cover the '''SimTX Transmitter''' desktop application: station setup, transmitting, antennas and the calculations behind them.
__NOTOC__
<div style="border:1px solid #a2a9b1; border-top:4px solid #36c; padding:1em 1.4em; margin-bottom:1.2em;">
<span style="font-size:180%;">SimTX Wiki</span>


In case you haven't already, make sure to join [https://discord.gg/BxtpFJAs6c our discord server]!
'''SimTX is a shared radio simulation.''' You set up virtual stations, transmit audio and listen with an SDR program. Distance, antennas and radio conditions change what listeners hear.


== Start here ==
</div>
* [[SimTX Transmitter]]: what the software is and how it fits together
* [[Getting Started]]: connect to a server and make a first transmission
* [[Transmitter Interface]]: reference for every control in the window


== Operating ==
== Getting started ==
* [[Modulation Modes]]
'''[[Getting Started]]''': install the app, sign in, create a station, transmit and listen.
* [[Transmission Sources]]
* [[Radio Presets]]
* [[Advanced Transmitter Settings]]
* [[Station Configuration]]
* [[Sessions and Queueing]]
* [[Power Amplifier Behaviour]]
* [[SWR and Transmitter Protection]]


== Extensions and sharing ==
== User guides ==
* [[Lua extensions]]: installing, managing, and using transmitter extensions
* '''[[SimTX Guide/Transmitting|Transmitting]]''' and '''[[SimTX Guide/Receiving|Receiving]]''': the Transmit and Receive tabs.
* [[Creating Lua extensions]] and [[Lua extension API]]: package creation and the public Lua interface
* '''[[SimTX Guide/Stations|Stations]]''': your stations, antennas and radios.
* [[Extension catalog]]: browsing, previewing, installing, and publishing extensions and station presets
* '''[[SimTX Guide/Satellites|Satellites]]''': launch a satellite, follow its passes and deorbit it.
* '''[[SimTX Guide/Rotators and tracking|Rotators and tracking]]''': turn an antenna or follow a satellite.
* '''[[SimTX Guide/Map and coverage|Map and coverage]]''': the globe, station lists and coverage maps.
* '''[[SimTX Guide/Catalog and add-ons|Catalog and add-ons]]''', '''[[SimTX Guide/Health|Health]]''', '''[[SimTX Guide/Settings and shortcuts|Settings and shortcuts]]''' and '''[[SimTX Guide/Troubleshooting|Troubleshooting]]'''.
* '''[[CLI]]''': CLI documentation, for integrations.


== Antennas ==
All guides are listed on [[SimTX Guide]].
* [[Antenna System]]: overview and configuration
* Types: [[Dipole Antenna]] · [[Inverted-V Antenna]] · [[Vertical Antenna]] · [[Yagi Antenna]] · [[Full-Wave Loop Antenna]] · [[Longwire Antenna]] · [[Beverage Antenna]] · [[End-Fed Half-Wave Antenna]]
* [[NEC File Import]]: custom antenna geometries
* [[Antenna Calculations]]: sizing, decibels, SWR arithmetic


== Understanding the simulation ==
== For developers ==
* [[Propagation Basics]]: groundwave, skywave, MUF and LUF, noise, and whether a signal will be heard
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 ==
== Learn in order ==
* [[:Category:Radio Stations]]: station pages made by users, and how to add your own
# '''[[SimTX Guide/Transmitting|Find your way around]]''': the Transmit tab's controls and meters. The Java transmitter's window is described on [[Transmitter Interface]].
# '''[[Transmission Sources|Choose what to send]]''': play a file, use a microphone, or send a stream.
# '''[[Antenna System|Change frequency and coverage]]''': choose and adjust an antenna, then learn [[Propagation Basics|why reception changes]].
# '''[[Lua extensions|Add features]]''': install modes, audio processors, tools, and themes without writing code.
# '''[[How to receive|Receive]]''': listen with any [[wikipedia:Software-defined_radio|SDR]] program.
 
[[File:SimTX Transmitter desktop app.png|thumb|center|850px|alt=SimTX desktop app window on the Stations tab: a globe of Europe and Africa with Demo hilltop, an orange TX beam at 300°, a blue RX beam at 180°, dashed lines to satellites, orbit rings, and the station's details in the sidebar.|The SimTX desktop app on the Stations tab, with a station on air, its beam headings and the satellites in view.]]
 
== Find a specific answer ==
* '''Nothing happens or no sound?''' See [[SimTX Guide/Troubleshooting|Troubleshooting]], or [[Troubleshooting]] for the Java transmitter.
* '''Which radio mode should I choose?''' See [[Modulation Modes]].
* '''How do I save or share my station setup?''' See [[SimTX Guide/Stations|Stations]] and [[Extension catalog]]. For the Java transmitter, see [[Station Configuration]].
* '''What do SWR, bandwidth, and IQ mean?''' See [[Radio terms]].
* '''Looking for formulas or the Lua API?''' See the [[Documentation|documentation index]].
 
== Community and other ways to use SimTX ==
* [[: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.
* [[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]

Latest revision as of 21:33, 25 October 2026

SimTX Wiki

SimTX is a shared radio simulation. You set up virtual stations, transmit audio and listen with an SDR program. Distance, antennas and radio conditions change what listeners hear.

Getting started

Getting Started: install the app, sign in, create a station, transmit and listen.

User guides

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. Find your way around: the Transmit tab's controls and meters. The Java transmitter's window is described on Transmitter Interface.
  2. Choose what to send: play a file, use a microphone, or send a stream.
  3. Change frequency and coverage: choose and adjust an antenna, then learn why reception changes.
  4. Add features: install modes, audio processors, tools, and themes without writing code.
  5. Receive: listen with any SDR program.
SimTX desktop app window on the Stations tab: a globe of Europe and Africa with Demo hilltop, an orange TX beam at 300°, a blue RX beam at 180°, dashed lines to satellites, orbit rings, and the station's details in the sidebar.
The SimTX desktop app on the Stations tab, with a station on air, its beam headings and the satellites in view.

Find a specific answer

Community and other ways to use SimTX