Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve formatting in the README #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 43 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,59 @@
Replacement tool for creative building (Mod for MineTest)
# Replacement tool for creative building (Minetest mod)

This tool is helpful for creative purposes (i.e. build a wall and "paint" windows into it).
It replaces nodes with a previously selected other type of node (i.e. places said windows
into a brick wall).
This tool is helpful for creative purposes (for example, building a wall then
"painting" windows into it). It replaces nodes with a previously-selected
node (i.e. places said windows into a brick wall).

Crafting: chest - -
- stick -
- - chest
Or just use /giveme replacer:replacer
## Crafting

Usage: Right-click on a node of that type you want to replace other nodes with.
Left-click (normal usage) on any nodes you want to replace with the type you previously right-clicked on.
SHIFT-Right-click in order to store a new pattern.
```text
chest - -
- stick -
- - chest
```

When in creative mode, the node will just be replaced. Your inventory will not be changed.
Or just use `/giveme replacer:replacer`.

When not in creative mode, digging will be simulated and you will get what was there. In return, the replacement node
will be taken from your inventory.
## Usage

- <kbd>Right-click</kbd> on a node of that type you want to replace
other nodes with.
- <kbd>Left-click</kbd> (normal usage) on any nodes you want to replace
with the type you previously right-clicked on.
- <kbd>Shift + Right-click</kbd> to store a new pattern.

The second tool included in this mod is the inspector.
When in creative mode, the node will just be replaced; your inventory
won't be changed.

When *not* in creative mode, digging will be simulated and you will get
what was there. In return, the replacement node will be taken from
your inventory.

Crafting: torch
stick
The second tool included in this mod is the inspector.

Just wield it and click on any node or entity you want to know more about. A limited craft-guide is included.
### Crafting the inspector

```text
torch
stick
```

Just wield it then click on any node or entity you want to know more about.
A limited crafting guide is included.

Copyright (C) 2013,2014,2015 Sokomine
## License

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.
Copyright (C) 2013, 2014, 2015 Sokomine

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.
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.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
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, see <http://www.gnu.org/licenses/>.