easyvend/API.md

# Easyvend API
Use this API if you want to make an container compatible with vending and
depositing machines.

## How it works

* Add `easyvend` as optional dependency
* Check for existence of `easyvend` mod in code
* Call `easyvend.register_chest` for all containers you want to be compatible

## `easyvend.register_chest = function(node_name, inv_list, meta_owner)`
Registers a node (called “chest”) for use with Easyvend. After calling this function,
the node will be recognized as storage for vending and depositing machines.

Easyvend makes the following assumptions about the chest:
* It has an inventory
* The inventory does not restrict the types of items you can put and take
* The chest is owned by a player
* The owner is specified in metadata

### Parameters 
* `node_name`: Name of the chest node
* `inv_list`: Name of the inventory list for exchanging items
* `meta_owner`: Identifier of the metadata variable storing the owner name

### Example

Register the node `example:superchest` as container:

```
if minetest.get_modpath("easyvend") then
    easyvend.register_chest("example:superchest", "main", "owner")
end
```

The `if` check is a common trick to check for the existence of the `easyvend`
and allows you to make the dependency optional.