hbsprint/README.md

40 lines
1.7 KiB
Markdown
Raw Normal View History

2017-07-12 01:07:32 +02:00
# hbSprint
## Description
A flexible sprint mod supporting stamina, hunger and coexistance with other physics altering mods.
## Licensing
- LGPLv2.1/CC BY-SA 3.0. Particle code: copyright (c) 2017 Elijah Duffy.
- sprint_stamina_\*icon textures:
- CC0
- Created by Jordan Irwin (AntumDeluge)
- Based on [Running man icon by manio1](https://openclipart.org/detail/254287)
2017-07-12 01:07:32 +02:00
## Notes
hbSprint can be played with Minetest 0.4.16 or above.
2019-10-17 17:36:23 +02:00
It has no dependencies, but supports [hudbars](https://repo.or.cz/minetest_hudbars.git) and [player_monoids](https://github.com/minetest-mods/player_monoids).
Compatible hunger mods: [hbhunger](https://repo.or.cz/minetest_hbhunger.git) or [hunger_ng](https://gitlab.com/4w/hunger_ng).
2017-07-12 01:07:32 +02:00
## List of features
- Displays and drains stamina (by default, if hudbars is present). Hides stamina bar if full.
2019-10-17 17:36:23 +02:00
- Displays and drains satiation (by default, if compatible hunger mod found)
2017-07-24 21:42:33 +02:00
- Drains air faster while sprinting on walkable ground but in water (by default)
2017-07-12 01:07:32 +02:00
- Requires only forward key to be pressed, not left and right (by default)
2017-07-24 21:42:33 +02:00
- Requires walkable ground (no water surface sprinting)
2017-07-12 01:28:15 +02:00
- Particle spawning based on ground type (Thanks to [octacian](https://github.com/octacian/sprint/))
2017-07-12 01:07:32 +02:00
- All variables customizable in Advanced settings or directly in minetest.conf
2017-07-12 01:07:32 +02:00
## Known issues
- Forward double tap support not implemented
## Bug reports and suggestions
You can report bugs or suggest ideas by [filing an issue](http://github.com/tacotexmex/hbsprint/issues/new).
## Links
2019-10-17 17:36:23 +02:00
* [Download ZIP](https://github.com/minetest-mods/hbsprint/archive/master.zip)
* [Source](https://github.com/minetest-mods/hbsprint)
2017-07-12 18:50:17 +02:00
* [Forum thread](https://forum.minetest.net/viewtopic.php?f=9&t=18069&p=282981)