travelnet/README.md
Buckaroo Banzai 19f7bc2039 add the rest of the dye colors for travelnets (#19)
* add the rest of the dye colors for travelnets

* fix screenshot url in readme

* use markdown syntax for images

* add color fixes from OgelGames

Co-authored-by: OgelGames <olliverdc28@gmail.com>

* updated screenshots

Co-authored-by: BuckarooBanzay <BuckarooBanzay@users.noreply.github.com>
Co-authored-by: OgelGames <olliverdc28@gmail.com>
Co-authored-by: OgelGames <48543043+OgelGames@users.noreply.github.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
2021-07-14 15:46:59 +10:00

40 lines
2.0 KiB
Markdown

# Travelnet
[![luacheck](https://github.com/mt-mods/travelnet/workflows/luacheck/badge.svg)](https://github.com/mt-mods/travelnet/actions?query=workflow%3Aluacheck)
[![Integration test](https://github.com/mt-mods/travelnet/workflows/integration-test/badge.svg)](https://github.com/mt-mods/travelnet/actions?query=workflow%3Aintegration-test)
[![ContentDB](https://content.minetest.net/packages/mt-mods/travelnet/shields/downloads/)](https://content.minetest.net/packages/mt-mods/travelnet/)
## How this works
- craft it by filling the right and left row with glass; place in the middle row (from top to bottom): steel, mese, steel
- place the travelnet box somewhere
- right-click on it; enter name of the station (e.g. "my house", "center of desert city") and name of the network (e.g. "intresting towns","my buildings")
- punch it to update the list of stations on that network
- right-click to use the travelbox
An unconfigured travelnet box can be configured by anyone. If it is misconfigured, just dig it and place it anew.
All stations that have the same network name set and are owned by the same user connect to the same network.
## Documentation
* [API](./doc/api.md)
## Screenshots
![](screenshot.png)
![](screenshot_day.png)
![](screenshot_night.png)
## License
The mod was written by me, Sokomine, and includes small contributions from other contributors.
License: GPLv3 (see [`LICENSE`](https://github.com/mt-mods/travelnet/blob/master/LICENSE) for more information)
The models and textures as found in the textures/ and models/ folders where created by VanessaE
and are provided under the [CC0](https://creativecommons.org/publicdomain/zero/1.0/) license.
Exceptions:
* `textures/travelnet_top.png` [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) https://github.com/minetest/minetest_game (`default_steel_block.png`)
* `textures/travelnet_bottom.png` [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) https://github.com/minetest/minetest_game (`default_clay.png`)