mtcontrib/maidroid
1
0
Fork 1
mirror of https://github.com/tacigar/maidroid.git synced 2024-11-05 09:40:34 +01:00
Code Issues Releases Wiki Activity

Merge pull request #71 from tacigar/tacigar/readme

Browse Source 
Update README.md
This commit is contained in:
tacigar 2016-12-18 00:23:39 +09:00 committed by GitHub
commit cebe90917a
1 changed files with 50 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -1,26 +1,63 @@
# Maidroid
Maidroid is a mod for Minetest which adds maid robots that can perform common tasks such as farming and cutting down trees.
![A screenshot of maid robots from the Maidroid mod](screenshot_readme.png)
## Overview
Maidroid MOD is a MOD for Minetest which adds maid robots, inspired by littleMaidMob.
## Usage
First, in order to create a maidroid, you have to craft an empty egg and an egg writer that convert eggs.
Those recipe is as follows.
<img src="http://i.imgur.com/6ZGQF4J.png" />
<img src="http://i.imgur.com/Y5tzPGM.png" />
After you place an egg writer node, and rightclick it, you have to place an empty egg to the slot labeled `Egg`, a coal to the slot labeled `Fuel`, and a dye to the slot labeled `Dye`.
The kind of the dye placed decides a egg produced.
The correspondences are as follows.
|Dye|Egg|
|:--|:--|
|`dye:red`|`maidroid:maidroid_mk1_egg`|
After a while, the empty egg will be converted to an new egg.
If you take and use it, a new maidroid will be born.
The maidroid, however, doesn't move now.
In order to have them move, you have to put a Core that is their brain.
You can create a core in a similar way to a maidroid egg.
First, you have to create an empty core and a core writer.
Those recipe is as follows.
<img src="http://i.imgur.com/Sxnr38Y.png">
<img src="http://i.imgur.com/97VENIl.png">
After you place a core writer node, rightclick it, and place a empty core to the slot labeled `Core`, a coal to the slot labeled `Fuel`, and a dye to the slot labeled `Dye`.
The correspondences of dyes and cores are as follows.
|Dye|Core|Description|
|:--|:--|:--|
|`dye:red`|`maidroid_core:basic`|Following the player.|
When a new core is created, put it to the maidroid.
Rightclick it, and put the core to the slot labeled `Core`.
The maidroid will start.
## Dependencies
* default
* dye
- bucket
- default
- dye
## Forum Topic
The forum topic for this mod on the Minetest Forums is located at:
* https://forum.minetest.net/viewtopic.php?f=9&t=14808
## License
The source code of Maidroid is available under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) or later license.
The resouces included in Maidroid are available under the [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) or later license.
- The source code of Maidroid is available under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.html) or later license.
- The resouces included in Maidroid are available under the [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) or later license.
---
## `maidroid/maidroid_tool`
### Core Writer
![Core Writer](core_writer.gif)
## Contributers