Add comment in minecart code
[MineClone/MineClone2.git] / mods / PLAYER / mcl_sprint / README.md
blobf9f45d442ed7be46d4a41ce3a094fffabb0e9ae4
1 # Sprint Mod for MineClone 2
2 Forked from [sprint] by GunshipPenguin  
4 ## Description
5 Allows the player to sprint by pressing the “Use” key (default: E).
6 By default, sprinting will make the player travel 80% faster and 
7 allow him/her to jump 10% higher. 
9 Licence: CC0 (see COPYING file)
11 ## Mod developer settings (`init.lua`)
12 ### `mcl_sprint.SPEED`
13 How fast the player will move when sprinting as opposed to normal 
14 movement speed. 1.0 represents normal speed so 1.5 would mean that a 
15 sprinting player would travel 50% faster than a walking player and 
16 2.4 would mean that a sprinting player would travel 140% faster than 
17 a walking player.