games/devtest/mods/testtools/README.md

   1 # Test Tools readme
   2
   3 Test Tools is a mod for developers that adds a bunch of tools to directly manipulate nodes and entities. This is great for quickly testing out stuff.
   4
   5 Here's the list of tools:
   6
   7 ## Remover
   8 Removes nodes and non-player entities that you punch.
   9
  10 ## Node Setter
  11 Replace a node with another one.
  12
  13 First, punch a node you want to remember.
  14 Then rightclick any other node to replace it with the node you remembered.
  15
  16 If you rightclick while pointing nothing, you can manually enter the node and param2.
  17
  18 ## Param2 Tool
  19 Change the value param2 of nodes.
  20
  21 * Punch: Add 1 to param2
  22 * Sneak+Punch: Add 8 to param2
  23 * Place: Subtract 1 from param2
  24 * Sneak+Place: Subtract 8 from param2
  25
  26 Note: Use the debug screen (F5) to see the param2 of the pointed node.
  27
  28 ## Falling Node Tool
  29 Turns nodes into falling nodes.
  30
  31 Usage:
  32
  33 * Punch node: Make it fall
  34 * Place: Try to teleport up to 2 units upwards, then make it fall
  35
  36 ## Node Meta Editor
  37 Edit and view metadata of nodes.
  38
  39 Usage:
  40
  41 * Punch: Open node metadata editor
  42
  43 ## Entity Rotator
  44 Changes the entity rotation (with `set_rotation`).
  45
  46 Usage:
  47
  48 * Punch entity: Rotate yaw
  49 * Punch entity while holding down “Sneak” key: Rotate pitch
  50 * Punch entity while holding down “Special” key (aka “Aux”): Rotate roll
  51
  52 Each usage rotates the entity by 22.5°.
  53
  54 ## Entity Spawner
  55 Spawns entities.
  56
  57 Usage:
  58
  59 * Punch to select entity or spawn one directly
  60 * Place to place selected entity
  61
  62 ## Object Property Editor
  63 Edits properties of objects.
  64
  65 Usage:
  66
  67 * Punch object to open a formspec that allows you to view and edit properties
  68 * Punch air to edit properties of your own player object
  69
  70 To edit a property, select it in the list, enter a new value (in Lua syntax)
  71 and hit “Submit”.
  72
  73 ## Object Attacher
  74 Allows you to attach an object to another one.
  75
  76 Basic usage:
  77 * First select the parent object, then the child object that should be attached
  78 * Selecting an object is done by punching it
  79 * Sneak+punch to detach selected object
  80 * If you punch air, you select yourself
  81
  82 Configuration:
  83 * Place: Increase attachment Y position
  84 * Sneak+place: decrease attachment Y position
  85 * Aux+place: Increase attachment X rotation
  86 * Aux+Sneak+Rightclick: Decrease attachment X rotation
  87
  88 Hint: To detach all objects nearby you (including on yourself), use the
  89 `/detach` server command.
  90
  91 ## Object Mover
  92 Move an object by a given distance.
  93
  94 Usage:
  95 * Punch object into the direction you want to move it
  96 * Sneak+punch: Move object towards you
  97 * Place: Increase move distance
  98 * Sneak+place: Decrease move distance
  99
 100 ## Children Getter
 101 Shows list of objects that are attached to an object (aka "children") in chat.
 102
 103 Usage:
 104 * Punch object: Show children of punched object
 105 * Punch air: Show your own children
 106
 107 ## Entity Visual Scaler
 108 Change visual size of entities
 109
 110 Usage:
 111
 112 * Punch entity to increase visual size
 113 * Sneak+punch entity to decrease visual size
 114
 115 ## Light Tool
 116 Show light level of node.
 117
 118 Usage:
 119 * Punch: Show light info of node in front of the punched node's side
 120 * Place: Show light info of the node that you touched