From 407098c76c3fd8d055050b7deeb8459cd7d275ca Mon Sep 17 00:00:00 2001 From: Panquesito7 Date: Sun, 10 Nov 2019 16:20:01 -0600 Subject: [PATCH] Improve README.md --- README.txt => README.md | 43 +++++++++++++++++------------------------ 1 file changed, 18 insertions(+), 25 deletions(-) rename README.txt => README.md (62%) diff --git a/README.txt b/README.md similarity index 62% rename from README.txt rename to README.md index 994a6ef..0717e23 100644 --- a/README.txt +++ b/README.md @@ -1,12 +1,9 @@ - Minetest mod: boost_cart -========================== +# Boost Cart Based on (and fully compatible with) the mod "carts" by PilzAdam and the one contained in the subgame "minetest_game". Target: Run smoothly as possible, even on laggy servers. - - Features ----------- +## Features - A fast cart for your railway or roller coaster - Easily configurable cart speed using the Advanced Settings - Boost and brake rails @@ -16,42 +13,38 @@ Target: Run smoothly as possible, even on laggy servers. - Handbrake with the 'back' key - Support for non-minetest_game subgames - - Settings ----------- +## Settings This mod can be adjusted to fit the conditions of a player or server. Use the Advanced Settings dialog in the main menu or tune your minetest.conf file manually: -boost_cart.speed_max = 10 - ^ Possible values: 1 ... 100 - ^ Maximal speed of the cart in m/s +- `boost_cart.speed_max = 10` + - ^ Possible values: 1 ... 100 + - ^ Maximal speed of the cart in m/s -boost_cart.punch_speed_max = 7 - ^ Possible values: -1 ... 100 - ^ Maximal speed to which the driving player can accelerate the cart - by punching from inside the cart. -1 will disable this feature. +- `boost_cart.punch_speed_max = 7` + - ^ Possible values: -1 ... 100 + - ^ Maximal speed to which the driving player can accelerate the cart + by punching from inside the cart. `-1` will disable this feature. - - License for everything ------------------------- +## License for everything CC-0, if not specified otherwise below Authors --------- Various authors - carts_rail_*.png +- carts_rail_*.png kddekadenz - cart_bottom.png - cart_side.png - cart_top.png +- cart_bottom.png +- cart_side.png +- cart_top.png klankbeeld (CC-BY 3.0) http://freesound.org/people/klankbeeld/sounds/174042/ - cart_rail.*.ogg +- cart_rail.*.ogg Zeg9 - cart.x - cart.png \ No newline at end of file +- cart.x +- cart.png \ No newline at end of file