Update item help
[minetest_easyvend.git] / README.md
blobcf7b453429459f6c2ece5c6cbf190fb9b78e5015
1 # Easy Vending Machines [`easyvend`]
2 Version: 0.2.0
4 Adds vending and depositing machines which allow to buy and sell items from other players.
6 Help is included as help entry for Item Documentation [`doc_items`].
8 ## Converting machines from `vendor` mod (experimental)
9 This mod is able to automatically transform the vending and depositing
10 machines from Bad\_Command_'s Vending machines [`vendor`] mod on loading
11 and turn them into the new machines from `easyvend`. This is useful if
12 you want to switch a world from `vendor` to `easyvend`.
14 **WARNING**: This feature is experimental! It is advised to backup your world
15 before doing this. This feature is also incomplete; items are currently
16 **not** transformed in the process.
18 ### Conversion process
19 To transform all nodes from the `vendor` mod, disable the `vendor` mod (if
20 it is not already disabled), enable the setting `easyvend_convert_vendor`
21 and start or restart the game.
23 Now all nodes from the `vendor` mod will be replaced  with `easyvend` ones.
25 If you run a server, you should inform players of this change because a few
26 machines might need a reconfiguration.
28 ### Details
29 The machine configuration will be kept in the process and the machines will
30 stay in operation provided their configuration is valid. The mod tries to
31 keep as many machines in operation as possible. Machines with very high values
32 (item count or price) might be disabled because they exceed limits and must
33 be reconfigured by their owners. Most machines which worked before will likely
34 stay in operation afterwards.
36 ## Licenses
37 - Code: LGPL 2.1. Forked from mod “Vending Machines” [vendor] by Bad_Command_.
38 - Sounds: CC-BY 3.0/CC-BY-SA 3.0/GPL 3.0/GPL 2.0
39 - Textures: MIT License