/itemshelf

Generic item shelf mod for Minetest with 3D items.

Primary LanguageLuaMIT LicenseMIT

Itemshelf

ContentDB

The item shelf mod is a simple mod that adds to shelves that can hold up to 4 or 6 items. This small limitation is due to the fact that shelves show the items they are holding using entities. The entities are purely static and consume 0 CPU (like the ones in itemframes for example), but still the limitation is to avoid lag.

Shelves should work with protection mods (currently only tested with areas mod). Without any protection they are public, otherwise they obey the proection of the area

There are three different types of shelves, and all three come in two different flavors: holding 4 or 6 items.

  • Shelf: like a bookshelf, one cube wide
  • Half shelf: while not exactly half a cube, it is less deep
  • Half open shelf: like the above, but with no back

Developers

Developers using this mod can register a particular node to use the item shelf functionality. To do that, the following function is used:

itemshelf.register_shelf(name, def)

where name is the name of the node (itemshelf: will be the prefix) and def is a Lua table defining the following:

  • description: shown in inventory
  • textures (if drawtype is nodebox)
  • nodebox (like default minetest.register_node def). Do not use with mesh.
  • mesh (like default minetest.register_node def). Do not use with nodebox.
  • item capacity (how many items will fit into the shelf, use even numbers, max 16)
  • shown_items (how many items to show, will always show first (shown_items/2) items of each row, max 6)

License

All code is copyright (C) 2018 Hector Franqui (zorman2000), licensed under the MIT license. See LICENSE for details.

Roadmap

  • Add shelves in all varieties of woods
  • Add crafting recipe
  • Add sounds
  • Allow shelves to contain only specific items
  • Allow overlays if shelf holds specific items

Preview