From 2bd0f61b77b5e8bd0298ace06c8c7ecb073bd39b Mon Sep 17 00:00:00 2001 From: Serhii Mozhaiskyi Date: Tue, 17 Dec 2019 17:29:16 +0200 Subject: [PATCH] update README --- README.md | 160 +++++++++++++++++++++++++++--------------------------- 1 file changed, 80 insertions(+), 80 deletions(-) diff --git a/README.md b/README.md index 9679919..d38a8f7 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,80 @@ -# Ham Radio - -![Ham Radio screenshot](screenshot.png?raw=true) - -This mod brings radio transmitters and receivers to the Minetest world. - -Dependencies: -``` -default -basic_materials? -technic? -digilines? -``` -Craft recipes depend of the mods installed. - -## Transmitter - -Craft a transmitter and place it in the world. Right click on transmitter to open configuration dialog, then set frequency and RDS message. -- Empty frequency turns transmitter off. -- Transmitter information is displayed as info text when player points at it. -- RDS message can be multiline. However, it is transmitted line by line. -- RDS message and frequency can be set via digiline. Also, you can read transmitter configuration via digiline too. - -## Beacon - -Beacon is a simplified transmitter. After placement it automatically tunes on a random unoccupied frequency from predefined range. Beacon frequency range is determined by `beacon_frequency` setting. -- Beacon frequency is displayed as info text when player points at it. - -## Receiver - -Handheld receiver is a wielded tool. - -- Left click opens configuration dialog to set frequency. Empty string turns receiver off. -- Shift + left click toggles reception of RDS messages. - -When receiver is tuned to a frequency where at least one transmitter is present, HUD signal meter bar shows signal power. The signal power depends on distance and direction to the transmitter. - -If RDS reception is toggled on, the RDS messages from all transmitters on this frequency are enqueued and will be send one by one as a chat messages to the player with 10 seconds interval. When RDS message queue becomes empty, it refills and starts over again. - -## Stationary Receiver - -Right click on receiver opens configuration window to set frequency. Receiver displays RDS messages as infotext in the same way as handheld receiver. It does not have signal power meter. -- You can operate the receiver in the same way as the transmitter. - -## Digiline - -```lua --- channel "ham_radio_rds" accepts plain text -digiline.send('ham_radio_rds', 'new RDS message') - --- get transmitter info -digiline.send('ham_radio', { command = 'get' }) --- returns { frequency = 12345, rds_message = 'text' } - --- set frequency -digiline.send('ham_radio', { command = 'set_frequency', value = '12345' }) --- returns { update = 'frequency', success = true/false, message = errorMessage } - --- set RDS message -digiline.send('ham_radio', { command = 'set_rds_message', value = 'new RDS message' }) --- returns { update = 'rds_message', success = true } -``` - -## What's next? - -- Place beacons or transmitters anywhere in the world, give frequency to other players and let them search for them -- Pick a frequency which all players can use for their announcements to organize radio bulletin board -- Operate your transmitters with digiline to receive notification on radio -- ??? -- PROFIT - -## Author and license - -(c) techniX 2019 - -Source code: MIT - -Textures: CC BY-SA 3.0 - -Sounds: cut from "G32-20-Tuning Radio" by craigsmith, CC 0 +# Ham Radio + +![Ham Radio screenshot](screenshot.png?raw=true) + +This mod brings radio transmitters and receivers to the Minetest world. + +Dependencies: +``` +default +basic_materials? +technic? +digilines? +``` +Craft recipes depend of the mods installed. + +## Transmitter + +Craft a transmitter and place it in the world. Right click on transmitter to open configuration dialog, then set frequency and RDS message. +- Empty frequency turns transmitter off. +- Transmitter information is displayed as info text when player points at it. +- RDS message can be multiline. However, it is transmitted line by line. +- RDS message and frequency can be set via digiline. Also, you can read transmitter configuration via digiline too. + +## Beacon + +Beacon is a simplified transmitter. After placement it automatically tunes on a random unoccupied frequency from predefined range. Beacon frequency range is determined by `beacon_frequency` setting. +- Beacon frequency is displayed as info text when player points at it. + +## Receiver + +Handheld receiver is a wielded tool. + +- Left click opens configuration dialog to set frequency. Empty string turns receiver off. +- Shift + left click toggles reception of RDS messages. + +When receiver is tuned to a frequency where at least one transmitter is present, HUD signal meter bar shows signal power. The signal power depends on distance and direction to the transmitter. + +If RDS reception is toggled on, the RDS messages from all transmitters on this frequency are enqueued and will be send one by one as a chat messages to the player with 10 seconds interval. When RDS message queue becomes empty, it refills and starts over again. + +## Stationary Receiver + +Right click on receiver opens configuration window to set frequency. Receiver displays RDS messages as infotext in the same way as handheld receiver. It does not have signal power meter. +- You can operate the receiver via digiline in the same way as the transmitter. + +## Digiline + +```lua +-- channel "ham_radio_rds" accepts plain text +digiline.send('ham_radio_rds', 'new RDS message') + +-- get transmitter info +digiline.send('ham_radio', { command = 'get' }) +-- returns { frequency = 12345, rds_message = 'text' } + +-- set frequency +digiline.send('ham_radio', { command = 'set_frequency', value = '12345' }) +-- returns { update = 'frequency', success = true/false, message = errorMessage } + +-- set RDS message +digiline.send('ham_radio', { command = 'set_rds_message', value = 'new RDS message' }) +-- returns { update = 'rds_message', success = true } +``` + +## What's next? + +- Place beacons or transmitters anywhere in the world, give frequency to other players and let them search for them +- Pick a frequency which all players can use for their announcements to organize radio bulletin board +- Operate your transmitters with digiline to receive notification on radio +- ??? +- PROFIT + +## Author and license + +(c) techniX 2019 + +Source code: MIT + +Textures: CC BY-SA 3.0 + +Sounds: cut from "G32-20-Tuning Radio" by craigsmith, CC 0