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 ## Item Meta Editor
  44 Edit and view metadata of items.
  45
  46 Usage:
  47
  48 * Place/Punch: Opens item metadata editor of the item in the next
  49                inventory slot from the wielded item
  50
  51 ## Entity Rotator
  52 Changes the entity rotation (with `set_rotation`).
  53
  54 Usage:
  55
  56 * Punch entity: Rotate yaw
  57 * Punch entity while holding down “Sneak” key: Rotate pitch
  58 * Punch entity while holding down “Special” key (aka “Aux”): Rotate roll
  59
  60 Each usage rotates the entity by 22.5°.
  61
  62 ## Entity Spawner
  63 Spawns entities.
  64
  65 Usage:
  66
  67 * Punch to select entity or spawn one directly
  68 * Place to place selected entity
  69
  70 ## Object Property Editor
  71 Edits properties of objects.
  72
  73 Usage:
  74
  75 * Punch object to open a formspec that allows you to view and edit properties
  76 * Punch air to edit properties of your own player object
  77
  78 To edit a property, select it in the list, enter a new value (in Lua syntax)
  79 and hit “Submit”.
  80
  81 ## Object Attacher
  82 Allows you to attach an object to another one.
  83
  84 Basic usage:
  85 * First select the parent object, then the child object that should be attached
  86 * Selecting an object is done by punching it
  87 * Sneak+punch to detach selected object
  88 * If you punch air, you select yourself
  89
  90 Configuration:
  91 * Place: Increase attachment Y position
  92 * Sneak+place: decrease attachment Y position
  93 * Aux+place: Increase attachment X rotation
  94 * Aux+Sneak+Rightclick: Decrease attachment X rotation
  95
  96 Hint: To detach all objects nearby you (including on yourself), use the
  97 `/detach` server command.
  98
  99 ## Object Mover
 100 Move an object by a given distance.
 101
 102 Usage:
 103 * Punch object into the direction you want to move it
 104 * Sneak+punch: Move object towards you
 105 * Place: Increase move distance
 106 * Sneak+place: Decrease move distance
 107
 108 ## Children Getter
 109 Shows list of objects that are attached to an object (aka "children") in chat.
 110
 111 Usage:
 112 * Punch object: Show children of punched object
 113 * Punch air: Show your own children
 114
 115 ## Entity Visual Scaler
 116 Change visual size of entities
 117
 118 Usage:
 119
 120 * Punch entity to increase visual size
 121 * Sneak+punch entity to decrease visual size
 122
 123 ## Branding Iron
 124 Give an object a temporary name.
 125
 126 Usage:
 127 * Punch object: Brand the object
 128 * Punch air: Brand yourself
 129 * The name is valid until the object unloads.
 130 * Devices that accept the returned name also accept "player:<playername>" for players.
 131
 132 Use `testtools.get_branded_object(name)` to get an ObjRef.
 133
 134 ## Note Meta Privatizer
 135 Sets the 'formspec' and 'infotext' metadata fields of a node
 136 to private. This means that clients can no longer access these
 137 fields.
 138 This only works for chests [`chest:chest`] at the moment.
 139
 140 Usage:
 141 * Punch: Set metadata of pointed node to private
 142
 143 ## Light Tool
 144 Show light level of node.
 145
 146 Usage:
 147 * Punch: Show light info of node in front of the punched node's side
 148 * Place: Show light info of the node that you touched
 149
 150 ## Particle Spawner
 151 Spawn a random animated particle.
 152
 153 Usage:
 154 * Punch: Spawn particle