Readme forum thread

This commit is contained in:
tacotexmex 2017-07-12 01:28:15 +02:00
parent 5ea6832452
commit 5a299b0a50

View File

@ -1,5 +1,5 @@
# hbSprint # hbSprint
License: LGPLv3/CC BY-SA 3.0. Particle code by copyright (c) 2017 Elijah Duffy, licensed MIT. License: LGPLv3/CC BY-SA 3.0. Particle code: copyright (c) 2017 Elijah Duffy, licensed MIT.
## Description ## Description
A flexible sprint mod supporting stamina, hunger and coexistance with other physics altering mods. A flexible sprint mod supporting stamina, hunger and coexistance with other physics altering mods.
@ -8,14 +8,13 @@ A flexible sprint mod supporting stamina, hunger and coexistance with other phys
hbSprint can be played with Minetest 0.4.16 or above. hbSprint can be played with Minetest 0.4.16 or above.
It supports on [hudbars](http://repo.or.cz/w/minetest_hudbars.git), [hbhunger](http://repo.or.cz/w/minetest_hbhunger.git) and [player_monoids](https://github.com/minetest-mods/player_monoids). It supports on [hudbars](http://repo.or.cz/w/minetest_hudbars.git), [hbhunger](http://repo.or.cz/w/minetest_hbhunger.git) and [player_monoids](https://github.com/minetest-mods/player_monoids).
Thanks to [octacian](https://github.com/octacian/sprint/) for particle code.
## List of features ## List of features
- Displays and drains stamina (by default, if hudbars is present). Hides stamina bar if full. - Displays and drains stamina (by default, if hudbars is present). Hides stamina bar if full.
- Displays and drains satiation (by default, if hbhunger is present) - Displays and drains satiation (by default, if hbhunger is present)
- Requires only forward key to be pressed, not left and right (by default) - Requires only forward key to be pressed, not left and right (by default)
- Requires walkable ground (no water sprinting) - Requires walkable ground (no water sprinting)
- Particle spawning based on ground type (Thanks to [octacian](https://github.com/octacian/sprint/))
- All variables customizable in Advanced settings or directly in minetest.conf - All variables customizable in Advanced settings or directly in minetest.conf
## Known issues ## Known issues
@ -25,4 +24,6 @@ Thanks to [octacian](https://github.com/octacian/sprint/) for particle code.
You can report bugs or suggest ideas by [filing an issue](http://github.com/tacotexmex/hbsprint/issues/new). You can report bugs or suggest ideas by [filing an issue](http://github.com/tacotexmex/hbsprint/issues/new).
## Links ## Links
* [GitHub](http://github.com/tacotexmex/hbsprint/) * [Download ZIP](https://github.com/tacotexmex/hbsprint/archive/master.zip)
* [Source](https://github.com/tacotexmex/hbsprint/)
* [Forum thread]https://forum.minetest.net/viewtopic.php?f=9&t=18069&p=282981