From 11490054e18a41b776d10faba745cc4b95c33f11 Mon Sep 17 00:00:00 2001 From: techniX Date: Sun, 8 Dec 2019 20:27:42 +0200 Subject: [PATCH] README and LICENSE --- LICENSE.txt | 7 +++++++ README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 LICENSE.txt create mode 100644 README.md diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..1a12df6 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,7 @@ +Copyright 2019 Serhii "techniX" Mozhaiskyi + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..095a16e --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Ham Radio + +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 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. +- Right 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. + +## 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 + +