README.md.diff 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. 1,62c1,7
  2. < Sprint Mod For Minetest by GunshipPenguin
  3. <
  4. < Allows the player to sprint by either double tapping w or pressing e.
  5. < By default, sprinting will make the player travel 80% faster and
  6. < allow him/her to jump 10% higher. Also adds a stamina bar that goes
  7. < down when the player sprints and goes up when he/she isn't
  8. < sprinting.
  9. <
  10. < This mod is compatible with the HUD bars [hudbars] mod, but does
  11. < not depend on it. In this care, a green HUD bar will be displayed,
  12. < also showing a number.
  13. < If this mod is not present, a standard statbar with 0-20
  14. < “half-arrows” is shown, which is a bit more coarse than the HUD
  15. < bar version.
  16. <
  17. <
  18. < Licence: CC0 (see COPYING file)
  19. <
  20. < ---
  21. <
  22. < This mod can be configured by changing the variables declared in
  23. < the start of init.lua. The following is a brief explanation of each
  24. < one.
  25. <
  26. < SPRINT_METHOD (default 1)
  27. <
  28. < What a player has to do to start sprinting. 0 = double tap w, 1 = press e.
  29. < Note that if you have the fast privlige, and have the fast
  30. < speed turned on, you will run very, very fast. You can toggle this
  31. < by pressing j.
  32. <
  33. < SPRINT_SPEED (default 1.5)
  34. <
  35. < How fast the player will move when sprinting as opposed to normal
  36. < movement speed. 1.0 represents normal speed so 1.5 would mean that a
  37. < sprinting player would travel 50% faster than a walking player and
  38. < 2.4 would mean that a sprinting player would travel 140% faster than
  39. < a walking player.
  40. <
  41. < SPRINT_JUMP (default 1.1)
  42. <
  43. < How high the player will jump when sprinting as opposed to normal
  44. < jump height. Same as SPRINT_SPEED, just controls jump height while
  45. < sprinting rather than speed.
  46. <
  47. < SPRINT_STAMINA (default 20)
  48. <
  49. < How long the player can sprint for in seconds. Each player has a
  50. < stamina variable assigned to them, it is initially set to
  51. < SPRINT_STAMINA and can go no higher. When the player is sprinting,
  52. < this variable ticks down once each second, and when it reaches 0,
  53. < the player stops sprinting. It ticks back up when the player isn't
  54. < sprinting and stops at SPRINT_STAMINA. Set this to a huge value if
  55. < you want unlimited sprinting.
  56. <
  57. < SPRINT_TIMEOUT (default 0.5)
  58. <
  59. < Only used if SPRINT_METHOD = 0.
  60. < How much time the player has after releasing w, to press w again and
  61. < start sprinting. Setting this too high will result in unwanted
  62. < sprinting and setting it too low will result in it being
  63. < difficult/impossible to sprint.
  64. ---
  65. > Sprint
  66. > =====================================================================
  67. > Main: GunshipPenguin
  68. > Lisc: CC0
  69. > Text: CC0
  70. > By Tirifto
  71. > Link: https://github.com/GunshipPenguin/sprint