Skip to content

Commit

Permalink
Convert README to Markdown (#30)
Browse files Browse the repository at this point in the history
Based on work by @Panquesito7
  • Loading branch information
SmallJoker committed Nov 20, 2019
1 parent ae33bd7 commit f7a649e
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 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
- A fast cart for your railway or roller coaster
- Easily configurable cart speed using the Advanced Settings
- Boost and brake rails
- By mesecons controlled Start-Stop rails
- Detector rails that send a mesecons signal when the cart drives over them
- Rail junction switching with the 'right/left' walking keys
- Handbrake with the 'back' key
- Support for non-minetest_game subgames

## Settings
This mod can be adjusted to fit the preference of a player or server. Use the `Settings -> All Settings` dialog in the main menu or tune your
minetest.conf file manually:

#### `boost_cart.speed_max = 10`
* Maximal speed of the cart in m/s
* Possible values: 1 ... 100

#### `boost_cart.punch_speed_max = 7`
* Maximal speed to which the driving player can accelerate the cart by punching from inside the cart.
* Possible values: -1 ... 100
* Value `-1` will disable this feature.

## License for everything
CC-0, if not specified otherwise below


Authors
---------
Various authors
- carts_rail_*.png

kddekadenz
- cart_bottom.png
- cart_side.png
- cart_top.png

klankbeeld (CC-BY 3.0)
- http://freesound.org/people/klankbeeld/sounds/174042/
- cart_rail.*.ogg

Zeg9
- cart.x
- cart.png

0 comments on commit f7a649e

Please sign in to comment.