From cbd717b5497f35669e2b1324de2b02bc75706f6b Mon Sep 17 00:00:00 2001 From: Hybrid Dog Date: Tue, 12 Sep 2017 10:49:57 +0200 Subject: [PATCH] Update README --- README.md | 47 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index be129ac..f712464 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # item_drop -By [PilzAdam](https://github.com/PilzAdam), [texmex](https://github.com/tacotexmex/). +By [PilzAdam](https://github.com/PilzAdam), +[texmex](https://github.com/tacotexmex/). ## Description This mod adds Minecraft like drop/pick up of items to Minetest. @@ -8,24 +9,44 @@ This mod adds Minecraft like drop/pick up of items to Minetest. LGPLv2.1/CC BY-SA 3.0. ## Notes -item_drop can be played with Minetest 0.4.16 or above. It was originally developed by [PilzAdam](https://github.com/PilzAdam/item_drop). +item_drop can be played with Minetest 0.4.16 or above. It was originally +developed by [PilzAdam](https://github.com/PilzAdam/item_drop). ## List of features -- All settings may be configured from within the game itself (Settings tab > Advanced settings > Mods > item_drop) -- Drops nodes as in-world items on dig if `enable_item_drop` is `true`. (true by default) -- Pulls items to the player's inventory if `enable_item_pickup` is `true`. (true by default) It uses a node radius set in `pickup_radius` (default 0.75) -- Plays a sound the items are picked up, with the gain level set it `pickup_gain` (default 0.2) -- Requires a key to be pressed in order to pull items if `enable_item_pickup_key` is `true`. (true by default). The keytypes to choose from by setting `item_pickup_keytype` are: - - Use key (`Use`) - - Sneak key (`Sneak`) - - Left and Right keys combined (`LeftAndRight`) - - Right mouse button (`RMB`) - - Sneak key and right mouse button combined (`SneakAndRMB`) +* All settings may be configured from within the game itself. + (Settings tab > Advanced settings > Mods > item_drop) +* Drops nodes as in-world items on dig if `item_drop.enable_item_drop` is + `true` (true by default) It does nothing in creative mode. +* Puts dropped items to the player's inventory if `item_drop.enable_item_pickup` + is `true` (true by default) + * It uses a node radius set in `item_drop.pickup_radius` (default 0.75), + if items are within this radius around the player's belt, they're picked. + * If `item_drop.pickup_age` is something positive, items dropped by players + are ignored for this time to avoid instantly picking up when dropping. + * If `item_drop.pickup_age` is `-1`, items are only picked when they don't + move, it's another fix for instant item picking. + * If `item_drop.magnet_radius` is bigger than `item_drop.pickup_radius`, + items between these radii are flying to the player for + `item_drop.magnet_time` seconds, after this time, they're picked or stop + flying. +* Plays a sound when the items are picked up with the gain level set to + `item_drop.pickup_sound_gain` (default 0.2) +* Requires a key to be pressed in order to pick items if + `item_drop.enable_pickup_key` is `true` (true by default) + * The keytypes to choose from by setting `item_pickup_keytype` are: + * Use key (`Use`) + * Sneak key (`Sneak`) + * Left and Right keys combined (`LeftAndRight`) + * Right mouse button (`RMB`) + * Sneak key and right mouse button combined (`SneakAndRMB`) + * If `item_drop.pickup_keyinvert` is `true` (false by default), items are + collected when the key is not pressed instead of when it's pressed. ## Known issues ## Bug reports and suggestions -You can report bugs or suggest ideas by [filing an issue](http://github.com/tacotexmex/item_drop/issues/new). +You can report bugs or suggest ideas by +[filing an issue](http://github.com/tacotexmex/item_drop/issues/new). ## Links * [Download ZIP](https://github.com/tacotexmex/item_drop/archive/master.zip)