isaiah658
/
minetest-floating_anchor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fill out README

master
Starbeamrainbowlabs 2018-05-15 15:25:09 +01:00
parent e9656e79ae
commit 564d2aa778
No known key found for this signature in database
GPG Key ID: 1BE5172E637709C2
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,5 +1,27 @@
# minetest-floating-anchor
A floating anchor mod for minetest. Adds an item that, when used, places a floating anchor block at the player's position.
## Installation
Clone this repository into the `worldmods` subfolder of the folder that contains your world. If it doesn't exist, then you'll need to create it.
## Usage
This mod adds two items:
1. A floating anchor node
2. A floating anchor item
As indicated by the description, the node is _not_ the one you should use. For general use, it's the item you want. If you try and place the item like a node (even if you're not pointing at anything), the node form will be placed at your current position.
Upon breaking, the node form will drop the item form again for you to re-use use. If you somehow end up with the node form in your inventory, simply place it normally and break it again to turn it back into the more useful item form.
## Contributing
Pull requests are welcome! By contributing, you agree to release your contribution under the same licenses that this repository is currently under.
### Todo List
- Figure out a clever hack to hide the node form in the creative inventory
- Don't deduct an item from players in creative mode when placing
- Don't drop an item for creative players breaking the node form
- ...? ([Open an issue](https://github.com/sbrl/minetest-floating_anchor/issues/new) or [send a pull request](https://github.com/sbrl/minetest-floating_anchor/compare)!)
## License
Everything here is licensed under the _Mozilla Public License 2.0_ - except the textures (which can be found in the `textures/` folder), which are licensed under CC-BY-SA (https://creativecommons.org/licenses/by-sa/4.0/). A copy of the Mozilla Public License 2.0 can be found in the `LICENSE` file in this repository.