Update and rename README.txt to README.md

master
Brett O'Donnell 2014-01-16 20:22:26 +10:30
parent 056a83060e
commit d8b36c3c60
2 changed files with 37 additions and 57 deletions

37
README.md Normal file
View File

@ -0,0 +1,37 @@
# Bags for Minetest
Allows players to craft and attach bags to their inventory to increase player item storage capacity.
## Features
- Bags are available in inventory.
- Multiple sized bags.
- Bags store items permanently with the player.
## Resources
- **[Documentation](http://cornernote.github.io/minetest-bags)**
- **[GitHub Project](https://github.com/cornernote/minetest-bags)**
- **[Minetest Forum](http://minetest.net/forum/viewtopic.php?id=3081)**
## Support
- Does this README need improvement? Go ahead and [suggest a change](https://github.com/cornernote/minetest-bags/edit/master/README.md).
- Found a bug, or need help using this project? Check the [open issues](https://github.com/cornernote/minetest-bags/issues) or [create an issue](https://github.com/cornernote/minetest-bags/issues/new).
## About
This module is open source, so it's distributed freely. If you find it useful then I ask not for your wealth, but simply to spare your time to consider the world we share by watching [Earthlings](http://earthlings.com/), a multi-award winning film available to watch online for free. A must-see for anyone who wishes to make the world a better place.
## Credits
- Tonyka - created the amazing bag textures
## License
[BSD-3-Clause](https://raw.github.com/cornernote/minetest-bags/master/LICENSE), Copyright © 2013-2014 [Brett O'Donnell](http://cornernote.github.io/)

View File

@ -1,57 +0,0 @@
----------------------------------
Bags for Minetest
----------------------------------
Copyright (c) 2012 cornernote, Brett O'Donnell <cornernote@gmail.com>
Textures: Copyright (c) 2012 tonyka
Source Code: https://github.com/cornernote/minetest-bags
Home Page: https://sites.google.com/site/cornernote/minetest/bags
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
----------------------------------
Description
----------------------------------
Allows players to craft and attach bags to their inventory to increase player item storage capacity.
----------------------------------
Crafts
----------------------------------
8-slot bag:
-S- <- bag:small
WWW S = default:stick
WWW W = default:wood
16-slot bag:
-S- <- bag:medium
BBB S = default:stick
BBB B = bags:small
24-slot bag:
-S- <- bag:large
BBB S = default:stick
BBB B = bags:medium
----------------------------------
Modders Guide
----------------------------------
To turn your craftitem into a bag simply add bagslots=X to the groups in the node definition.
EG:
minetest.register_node("your_mod:your_item", {
description = "Your Item",
groups = {bagslots=16},
})