Documentation - Revision history

Clanker: Tighten; list all user guides

2026-10-24T20:06:21Z

Tighten; list all user guides

← Older revision		Revision as of 20:06, 24 October 2026
Line 1:		Line 1:
	{{Documentation navigation}}		{{Documentation navigation}}

	~~This index separates practical guides from detailed references. New users should begin with [[Getting Started]], then choose the topic needed for their next task.~~

	== Start and operate ==		== Start and operate ==
	* [[SimTX Transmitter]]: what the application does and how the simulation fits together.		* [[SimTX Transmitter]]: what the application does and how the simulation fits together.
	* [[Getting Started]]: ~~installing~~ the desktop app, sign-in, ~~server selection, your first~~ station, ~~a first transmission,~~ and ~~receiving~~.		* [[Getting Started]]: install the desktop app, sign in, create a station, transmit and receive.
	* [[Transmitter Interface]]: ~~illustrated~~ control ~~reference~~.		* [[Transmitter Interface]]: the Java transmitter's window, control by control.
	* [[Transmission Sources]]: audio files, streams, microphone, PipeWire, and external IQ.		* [[Transmission Sources]]: audio files, streams, microphone, PipeWire, and external IQ.
	* [[Station Configuration]]: callsign, location, and ~~complete~~ station presets.		* [[Station Configuration]]: callsign, location and station presets in the Java transmitter.
	* [[Sessions and Queueing]]: start, stop, monitor, live edit, and reconnect.		* [[Sessions and Queueing]]: start, stop, monitor, live edit, and reconnect.
	* [[Troubleshooting]]: a symptom-by-symptom checklist.		* [[Troubleshooting]]: a symptom-by-symptom checklist for the Java transmitter.
	* [[Radio terms]]: short explanations of unfamiliar terms and units.		* [[Radio terms]]: short explanations of unfamiliar terms and units.

Line 43:		Line 41:

	== User guides ==		== User guides ==
	~~How stations, satellites and rotators work in~~ the desktop app, and ~~how~~ to ~~use them~~.		* [[SimTX Guide]]: all user guides for the desktop app.
	* [[SimTX Guide]]: ~~overview~~ and ~~where~~ to ~~find things~~.		* [[SimTX Guide/Transmitting]]: the Transmit tab, sources, presets, sessions and push-to-talk.
	* [[SimTX Guide/Stations]]: ~~create and edit~~ stations, antennas ~~and~~ radios~~, public~~ and ~~unlisted stations~~.		* [[SimTX Guide/Receiving]]: the Receive tab and the bridge to your SDR program.
	* [[SimTX Guide/Satellites]]: ~~launch~~ a satellite, passes, Doppler, deorbiting.		* [[SimTX Guide/Stations]]: stations, antennas, radios and visibility.
	* [[SimTX Guide/Rotators and tracking]]: ~~turn~~ an antenna ~~by hand or follow~~ a satellite.		* [[SimTX Guide/Satellites]]: launching a satellite, passes, Doppler and deorbiting.
			* [[SimTX Guide/Rotators and tracking]]: turning an antenna and following a satellite.
			* [[SimTX Guide/Map and coverage]]: the globe, station lists and coverage maps.
			* [[SimTX Guide/Catalog and add-ons]]: shared presets and packages, add-ons and actions.
			* [[SimTX Guide/Health]]: the server health report.
			* [[SimTX Guide/Settings and shortcuts]]: settings, the command palette and shortcuts.
			* [[SimTX Guide/Troubleshooting]]: problems and the app's messages.

	== Build your own software ==		== Build your own software ==
Line 59:		Line 63:

	== Other receiver and digital-mode guides ==		== Other receiver and digital-mode guides ==
	~~These community guides use additional software and assume the basic SimTX workflow is understood.~~
	* [[Guide to setting up sdr console with simtx\|SDR Console setup]]		* [[Guide to setting up sdr console with simtx\|SDR Console setup]]
	* [[DATV RX Tutorial\|Digital television reception]]		* [[DATV RX Tutorial\|Digital television reception]]
	* [[DATV TX Tutorial\|Digital television transmission]]		* [[DATV TX Tutorial\|Digital television transmission]]
	* [[DRM TX tutorial\|DRM transmission]]		* [[DRM TX tutorial\|DRM transmission]]
			* [[:Category:Radio Stations\|Community radio stations]]: stations described by their operators.
	~~Station descriptions are listed separately in~~ [[:Category:Radio Stations]].

	[[Category:SimTX]]		[[Category:SimTX]]

Clanker: Add the user guides

2026-10-24T19:42:44Z

Add the user guides

← Older revision		Revision as of 19:42, 24 October 2026
Line 5:		Line 5:
	== Start and operate ==		== Start and operate ==
	* [[SimTX Transmitter]]: what the application does and how the simulation fits together.		* [[SimTX Transmitter]]: what the application does and how the simulation fits together.
	* [[Getting Started]]: ~~download, Java~~, sign-in, server selection, first transmission, and ~~saving~~.		* [[Getting Started]]: installing the desktop app, sign-in, server selection, your first station, a first transmission, and receiving.
	* [[Transmitter Interface]]: illustrated control reference.		* [[Transmitter Interface]]: illustrated control reference.
	* [[Transmission Sources]]: audio files, streams, microphone, PipeWire, and external IQ.		* [[Transmission Sources]]: audio files, streams, microphone, PipeWire, and external IQ.
Line 22:		Line 22:
	== Antennas and coverage ==		== Antennas and coverage ==
	* [[Antenna System]]: choose an antenna and tune it for the frequency.		* [[Antenna System]]: choose an antenna and tune it for the frequency.
	* [[Dipole Antenna]] · [[Inverted-V Antenna]] · [[Vertical Antenna]]		* [[Dipole Antenna]], [[Inverted-V Antenna]], [[Vertical Antenna]]
	* [[Yagi Antenna]] · [[Full-Wave Loop Antenna]]		* [[Yagi Antenna]], [[Full-Wave Loop Antenna]]
	* [[End-Fed Half-Wave Antenna]] · [[Longwire Antenna]] · [[Beverage Antenna]]		* [[End-Fed Half-Wave Antenna]], [[Longwire Antenna]], [[Beverage Antenna]]
	* [[Propagation Basics]]: nearby and distant reception, day and night, noise, and fading.		* [[Propagation Basics]]: nearby and distant reception, day and night, noise, and fading.
	* [[Antenna Calculations]]: wavelength, wire lengths, decibels, SWR, and the path budget.		* [[Antenna Calculations]]: wavelength, wire lengths, decibels, SWR, and the path budget.
Line 41:		Line 41:
	* [[Lua action API]]: tools that read settings or control the transmitter.		* [[Lua action API]]: tools that read settings or control the transmitter.
	* [[Lua theme API]]: colors, fonts, and appearance.		* [[Lua theme API]]: colors, fonts, and appearance.

			== User guides ==
			How stations, satellites and rotators work in the desktop app, and how to use them.
			* [[SimTX Guide]]: overview and where to find things.
			* [[SimTX Guide/Stations]]: create and edit stations, antennas and radios, public and unlisted stations.
			* [[SimTX Guide/Satellites]]: launch a satellite, passes, Doppler, deorbiting.
			* [[SimTX Guide/Rotators and tracking]]: turn an antenna by hand or follow a satellite.

	== Build your own software ==		== Build your own software ==

Clanker: Point the developer section at the protocol v25 reference

2026-10-24T17:22:33Z

Point the developer section at the protocol v25 reference

← Older revision		Revision as of 17:22, 24 October 2026
Line 44:		Line 44:
	== Build your own software ==		== Build your own software ==
	The [[SimTX API]] reference is for developers who want to receive, transmit or read station data from their own programs.		The [[SimTX API]] reference is for developers who want to receive, transmit or read station data from their own programs.
	* [[SimTX API/Quick start]]: receive IQ ~~and transmit a tone~~ with a short standard-library program.		* [[SimTX API/Quick start]]: receive IQ with a short standard-library program.
	* [[SimTX API/Account service]]: sign-in, server directory, game tickets and public endpoints.		* [[SimTX API/Account service]]: sign-in, stations and satellites, server directory, game tickets and public endpoints.
	* [[SimTX API/Connection and handshake]]: the ~~binary~~ game protocol, version 24.		* [[SimTX API/Connection and handshake]]: the game protocol, version 25: TLS, the preface and the hello.
	* [[SimTX API/Receiver session]] · [[SimTX API/Transmitter session]] · [[SimTX API/Control session]]		* [[SimTX API/Receiver session]], [[SimTX API/Transmitter session]] and [[SimTX API/Control session]]: the kinds of game session.
	* [[SimTX API/Packet list]]: every ~~packet~~, each with its own page.		* [[SimTX API/Stations]] and [[SimTX API/Satellites]]: persistent stations and user-launched satellites.
			* [[SimTX API/Packet list]]: every message, each with its own page.

	== Other receiver and digital-mode guides ==		== Other receiver and digital-mode guides ==

Clanker: SimTX API documentation

2026-10-24T10:02:49Z

SimTX API documentation

← Older revision		Revision as of 10:02, 24 October 2026
Line 41:		Line 41:
	* [[Lua action API]]: tools that read settings or control the transmitter.		* [[Lua action API]]: tools that read settings or control the transmitter.
	* [[Lua theme API]]: colors, fonts, and appearance.		* [[Lua theme API]]: colors, fonts, and appearance.

			== Build your own software ==
			The [[SimTX API]] reference is for developers who want to receive, transmit or read station data from their own programs.
			* [[SimTX API/Quick start]]: receive IQ and transmit a tone with a short standard-library program.
			* [[SimTX API/Account service]]: sign-in, server directory, game tickets and public endpoints.
			* [[SimTX API/Connection and handshake]]: the binary game protocol, version 24.
			* [[SimTX API/Receiver session]] · [[SimTX API/Transmitter session]] · [[SimTX API/Control session]]
			* [[SimTX API/Packet list]]: every packet, each with its own page.

	== Other receiver and digital-mode guides ==		== Other receiver and digital-mode guides ==

Clanker: Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior

2026-09-13T21:20:11Z

Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior

New page

{{Documentation navigation}}

This index separates practical guides from detailed references. New users should begin with [[Getting Started]], then choose the topic needed for their next task.

== Start and operate ==
* [[SimTX Transmitter]]: what the application does and how the simulation fits together.
* [[Getting Started]]: download, Java, sign-in, server selection, first transmission, and saving.
* [[Transmitter Interface]]: illustrated control reference.
* [[Transmission Sources]]: audio files, streams, microphone, PipeWire, and external IQ.
* [[Station Configuration]]: callsign, location, and complete station presets.
* [[Sessions and Queueing]]: start, stop, monitor, live edit, and reconnect.
* [[Troubleshooting]]: a symptom-by-symptom checklist.
* [[Radio terms]]: short explanations of unfamiliar terms and units.

== Choose the signal and radio ==
* [[Modulation Modes]]: choosing a mode and the full bandwidth table.
* [[Radio Presets]]: simulated equipment types and their power levels.
* [[Advanced Transmitter Settings]]: every transmitter parameter, range, and default.
* [[SWR and Transmitter Protection]]: matching the antenna and understanding reduced power.
* [[Power Amplifier Behaviour]]: heating, cooling, foldback, and session damage.

== Antennas and coverage ==
* [[Antenna System]]: choose an antenna and tune it for the frequency.
* [[Dipole Antenna]] · [[Inverted-V Antenna]] · [[Vertical Antenna]]
* [[Yagi Antenna]] · [[Full-Wave Loop Antenna]]
* [[End-Fed Half-Wave Antenna]] · [[Longwire Antenna]] · [[Beverage Antenna]]
* [[Propagation Basics]]: nearby and distant reception, day and night, noise, and fading.
* [[Antenna Calculations]]: wavelength, wire lengths, decibels, SWR, and the path budget.
* [[NEC File Import]]: custom geometry, supported cards, and limitations.

== Use extensions ==
* [[Lua extensions]]: install and use modes, audio add-ons, tools, themes, and libraries.
* [[Extension catalog]]: preview, install, update, and publish shared packages and presets.

== Write extensions ==
Read [[Creating Lua extensions]] first. It contains a complete small package and the edit, reload, and test cycle.
* [[Lua extension manifest]]: package identity, versions, types, and dependencies.
* [[Lua extension API]]: registration, controls, inputs, and common helpers.
* [[Lua modulation API]]: audio and IQ blocks, images, video, files, and sample rates.
* [[Lua audio add-on API]]: the audio processing callback and block operations.
* [[Lua action API]]: tools that read settings or control the transmitter.
* [[Lua theme API]]: colors, fonts, and appearance.

== Other receiver and digital-mode guides ==
These community guides use additional software and assume the basic SimTX workflow is understood.
* [[Guide to setting up sdr console with simtx|SDR Console setup]]
* [[DATV RX Tutorial|Digital television reception]]
* [[DATV TX Tutorial|Digital television transmission]]
* [[DRM TX tutorial|DRM transmission]]

Station descriptions are listed separately in [[:Category:Radio Stations]].

[[Category:SimTX]]