Update and rename README.txt to README.md
This commit is contained in:
Brett O'Donnell
parent
a9353197e6
commit
9fb6373f88
45
README.md
Normal file
45
README.md
Normal file
@ -0,0 +1,45 @@
|
||||
# Deploy Nodes for Minetest
|
||||
|
||||
Craftable nodes that when placed turn into shapes or structures.
|
||||
|
||||
Features
|
||||
|
||||
- easy to use - no chat commands, just nice easy structures that you can build by crafting and placing nodes
|
||||
- lightweight - there are no ABMs, the nodes are created using after_place_node() in the node definitions
|
||||
- grief-resistant - before nodes deploy a check is run to ensure that only air exists in the new area
|
||||
- server friendly - all players can create impressive structures easily
|
||||
|
||||
|
||||
## Resources
|
||||
|
||||
- **[Documentation](http://cornernote.github.io/minetest-deploy_nodes)**
|
||||
- **[GitHub Project](https://github.com/cornernote/minetest-deploy_nodes)**
|
||||
- **[Minetest Forum](http://minetest.net/forum/viewtopic.php?id=3192)**
|
||||
|
||||
|
||||
## Support
|
||||
|
||||
- Does this README need improvement? Go ahead and [suggest a change](https://github.com/cornernote/minetest-deploy_nodes/edit/master/README.md).
|
||||
- Found a bug, or need help using this project? Check the [open issues](https://github.com/cornernote/minetest-deploy_nodes/issues) or [create an issue](https://github.com/cornernote/minetest-deploy_nodes/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
|
||||
|
||||
- mauvebic - author of multinode which provided code for spheres and cylinders
|
||||
- Echo - author of maze which provided code for spheres
|
||||
- neko259 - author of livehouse which inspired building spawning
|
||||
- VanessaE - contributed buildings
|
||||
- kddekadenz - contributed buildings
|
||||
- ACDC - contributed buildings
|
||||
- Nanuk - contributed buildings
|
||||
- irksomeduck - contributed buildings
|
||||
|
||||
|
||||
## License
|
||||
|
||||
[BSD-3-Clause](https://raw.github.com/cornernote/minetest-deploy_nodes/master/LICENSE), Copyright © 2013-2014 [Brett O'Donnell](http://cornernote.github.io/)
|
||||
75
README.txt
75
README.txt
@ -1,75 +0,0 @@
|
||||
----------------------------------
|
||||
Deploy Nodes for Minetest
|
||||
----------------------------------
|
||||
|
||||
Copyright (C) 2012 cornernote, Brett O'Donnell <cornernote@gmail.com>
|
||||
Home Page: https://sites.google.com/site/cornernote/minetest/deploy-nodes
|
||||
Source Code: https://github.com/cornernote/minetest-deploy_nodes
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Textures:
|
||||
deploy_nodes_blueprint.png - freeware - http://findicons.com/icon/178409/blueprint
|
||||
|
||||
|
||||
----------------------------------
|
||||
Description
|
||||
----------------------------------
|
||||
|
||||
Provides craftable nodes that when placed turn into shapes or structures.
|
||||
|
||||
Features:
|
||||
- easy to use - no chat commands, just nice easy structures that you can build by crafting and placing nodes
|
||||
- lightweight - there are no ABMs, the nodes are created using after_place_node() in the node definitions
|
||||
- grief-resistant - before nodes deploy a check is run to ensure that only air exists in the new area
|
||||
- server friendly - all players can create impressive structures easily
|
||||
|
||||
|
||||
----------------------------------
|
||||
How To Add New Stuff
|
||||
----------------------------------
|
||||
|
||||
New Shapes:
|
||||
|
||||
Shapes should be deployed in their own mod folder as follows:
|
||||
|
||||
-- init.lua --
|
||||
deploy_your_mod = {}
|
||||
deploy_your_mod.deploy = function(pos,placer)
|
||||
-- check for space
|
||||
if deploy_nodes.check_for_space==true and not enough_space then return end
|
||||
-- remove node
|
||||
minetest.env:remove_node(pos)
|
||||
-- build the thing
|
||||
-- ... your code here ...
|
||||
end
|
||||
minetest.register_node("deploy_your_mod:your_node", {
|
||||
after_place_node = deploy_your_mod.deploy,
|
||||
})
|
||||
|
||||
-- depends.txt --
|
||||
deploy_nodes
|
||||
|
||||
|
||||
New Buildings:
|
||||
|
||||
Simply drop them into deploy_building/buildings/[large|medium|small]. The mod will detect them automatically as long as they have a ".we" extension.
|
||||
|
||||
|
||||
----------------------------------
|
||||
Credits
|
||||
----------------------------------
|
||||
|
||||
mauvebic - author of multinode which provided code for spheres and cylinders
|
||||
Echo - author of maze which provided code for spheres
|
||||
neko259 - author of livehouse which inspired building spawning
|
||||
VanessaE - contributed buildings
|
||||
kddekadenz - contributed buildings
|
||||
ACDC - contributed buildings
|
||||
Nanuk - contributed buildings
|
||||
irksomeduck - contributed buildings
|
||||
Loading…
x
Reference in New Issue
Block a user