From 254156999ae377c23e5dcb0b1f92f0468312face Mon Sep 17 00:00:00 2001 From: Panquesito7 <51391473+Panquesito7@users.noreply.github.com> Date: Thu, 22 Aug 2019 19:56:10 -0500 Subject: [PATCH] Make "README.md" better --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f0626ca..38594f9 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# player_physics +# Player Physics A minetest mod to centralize the management of player's stats(sprint, jump, gravity) Because many mods (sprint, 3d_armor and others) rewrite the stats in their corner and it cancel -***API*** +## API - player_physics.set_stats(player, "uniq_name", table) - player_physics.remove_stats(player, "uniq_name") -**Exemple** +## API examples - player_physics.set_stats(player, "potion_speedlvl1", {speed=0.35}) @@ -17,12 +17,12 @@ Because many mods (sprint, 3d_armor and others) rewrite the stats in their corne - player_physics.remove_stats(player, "potion_speedlvl1") -**Temporary effect** +## Temporary effect - player_physics.add_effect(player, "uniq_name", time, stats) - player_physics.remove_effect(player, "uniq_name") -**Exemple** +## Code example You make a potion that adds speed for 10 seconds. on_use = function(itemstack, user, pointed_thing) @@ -30,6 +30,3 @@ You make a potion that adds speed for 10 seconds. itemstack:take_item() return itemstack end - - -