README.md

   1 # Easy Vending Machines [`easyvend`]
   2 Version: 1.0.0
   3
   4 Adds vending and depositing machines which allow to buy and sell items from
   5 other players, using a currency item.
   6
   7 ## Requirements
   8 Runs natively in Minetest Game.
   9
  10 May also run in other games if they have the `default` mod and locked chest
  11 (`default:chest_locked`).
  12
  13 Locked chests from other mods are not supported, but mods can choose
  14 to add support for Easyvend on their own (see developer information below).
  15
  16 You can optionally add the `select_item` mod. This adds a button to select
  17 an item from a list of items.
  18 This feature is very useful for depositing machines because you can select
  19 any item, not just those you have already in your inventory.
  20
  21 ## How to use
  22 Help is also included as help entry for Item Documentation [`doc_items`].
  23
  24 ### Summary
  25 Vending machines TAKE currency (gold ingots by default) and GIVE items
  26 of the owner's choice.
  27 Depositing machines GIVE currency and TAKE items of the owner's choice.
  28
  29 To operate your own machine, place a locked chest above or below and fill
  30 it with items to exchange. If the green status LED (the upper one) lights
  31 up, the machine is operational. You can stack these locked chests for
  32 extended storage.
  33
  34 ### Currency item
  35 The currency of all machines is gold ingots by default.
  36 But it can be changed via the setting `easyvend_currency`.
  37
  38
  39
  40 ## Appendix
  41 ### Developer information
  42 If you want to a container node compatible with vending/depositing machines,
  43 use the Easyvend API, see the file `API.md`.
  44
  45 ### Converting machines from `vendor` mod (experimental)
  46 This mod is able to automatically transform the vending and depositing
  47 machines from Bad\_Command\_'s Vending machines [`vendor`] mod on loading
  48 and turn them into the new machines from `easyvend`. This is useful if
  49 you want to switch a world from `vendor` to `easyvend`.
  50
  51 **WARNING**: This feature is experimental! It is advised to backup your world
  52 before doing this. This feature is also incomplete; items are currently
  53 **not** transformed in the process.
  54
  55 #### Conversion process
  56 To transform all nodes from the `vendor` mod, disable the `vendor` mod (if
  57 it is not already disabled), enable the setting `easyvend_convert_vendor`
  58 and start or restart the game.
  59
  60 Now all nodes from the `vendor` mod will be replaced  with `easyvend` ones.
  61
  62 If you run a server, you should inform players of this change because a few
  63 machines might need a reconfiguration.
  64
  65 #### Details
  66 The machine configuration will be kept in the process and the machines will
  67 stay in operation provided their configuration is valid. The mod tries to
  68 keep as many machines in operation as possible. Machines with very high values
  69 (item count or price) might be disabled because they exceed limits and must
  70 be reconfigured by their owners. Most machines which worked before will likely
  71 stay in operation afterwards.
  72
  73 ### Credits and licenses
  74 - Code
  75     - License: [LGPL 2.1](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)
  76     - Source: Forked from mod “Vending Machines” [vendor] by Bad\_Command\_.
  77     - Authors: Bad\_Command\_ and Wuzzy
  78 - Textures
  79     - License: MIT License
  80     - Author: Wuzzy
  81 - Sounds
  82     - Any of the following licenses apply:
  83         - [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/)
  84         - [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)
  85         - [GPL 3.0](https://www.gnu.org/licenses/gpl-3.0.html)
  86         - [GPL 2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0)
  87     - Original title of the work: “Inventory Sound Effects”
  88     - Source: [OpenGameArt](http://opengameart.org/content/inventory-sound-effects)
  89     - Authors: [OpenGameArt](http://opengameart.org/) user artisticdude, edited by Bad\_Command\_