README.md

   1 # Player tools 1.4 [playertools]
   2 This mod adds some player-related server commands and privileges to Minetest.
   3 Most commands are little helper tools, useful for modders and for messing
   4 around, but they aren’t really suitable for serious gameplay. Some commands
   5 are informational. The commands allow players to change their health, clear
   6 their inventory, set their player physics, and other stuff.
   7 The privileges are created for the health, physics and hotbar-related commands
   8 and are named “`heal`”, “`physics`” and “`hotbar`”, respectively.
   9
  10 ## List of commands
  11 ### No privileges required
  12
  13 * `/whoami`: Shows your name in a chat message.
  14 * `/ip`: Shows your IP address in a chat message.
  15 * `/pulverizeall`: Destroys all items in your player inventory and crafting grid.
  16 * `/killme`: Kills yourself.
  17
  18 ### “`hotbar`” privilege required
  19
  20 * `/sethotbarsize <1...23>`: Sets the number of slots in your hotbar (1-23).
  21
  22 ### “`heal`” privilege and damage required
  23
  24 * `/sethealth <hearts>`: Sets your health to `<hearts>` hearts.
  25 * `/sethp <hp>` Sets your health to `<hp>` HP (=half the number of “hearts”).
  26 * `/setbreath <breath>`: Sets your breath to `<breath>` breath points.
  27
  28 The “`sethp`” command rounds `<hp>`.
  29 The “`sethealth`” command rounds `<hearts>` to the nearest half, i.e:
  30
  31 * 2.5 → 2.5
  32 * 2.6 → 2.5
  33 * 2.7 → 2.5
  34 * 2.75 → 3
  35 * 2.8 → 3
  36
  37 ### “`physics`” privilege required
  38
  39 * `/setspeed [<speed>]`: Sets your movement speed to `<speed>` (default: 1).
  40 * `/setgravity [<gravity>]`: Sets your gravity to `<gravity>` (default: 1).
  41 * `/setjump [<jump height>]`: Sets your jump height to `<jump height>` (default: 1).
  42
  43 These commands directly edit the player’s physics parameters.
  44
  45
  46 ## Installation
  47 You can either install the player tools as an ordinary mod or as a builtin,
  48 but please don’t do both. Installing it as a mod is very easy, but you have
  49 to activate the mod explicitly for each map. Installing it as builtin is easy
  50 and the player tools are automatically available for every server you start.
  51
  52 To install it as a mod, just drop this folder into the `mods/` directory of your
  53 Minetest data folder.
  54
  55 To install it as builtin do this:
  56 (For version 0.4.9)
  57 Rename the file “`init.lua`” to “`mod_playertools.lua`” and move it to `<your Minetest installation folder>/builtin/`.
  58 Then edit the file `<your Minetest installation folder>/builtin/builtin.lua`. Add the following line of text at the
  59 end of the file:
  60
  61     dofile(modpath.."/mod_playertools.lua")
  62
  63 Save the file; you’re finished! The next time you start a server the player tools are available.
  64
  65 ## License
  66 This mod is free software, licensed under the MIT License.