Go to file
Jordan Irwin 0dbd7b1243 Add chat command to find names of nearby nodes 2021-07-31 01:19:52 -07:00
.github/workflows Add GitHub workflow for building HTML docs on gh-pages branch 2021-07-30 17:55:50 -07:00
.ldoc LDoc: some touch-ups to gendoc.sh script 2021-07-30 23:00:10 -07:00
locale Update localization template & Spanish translation 2021-07-30 17:18:37 -07:00
sounds
sounds_src Add sound sources used to created OGG files 2021-07-29 12:42:08 -07:00
textures
.cdb.json Add .cdb.json file for ContentDB updates 2021-07-30 23:48:00 -07:00
.gitattributes Add .cdb.json file for ContentDB updates 2021-07-30 23:48:00 -07:00
LICENSE.txt
README.md Add screenshot 2021-07-30 23:20:45 -07:00
TODO.txt Update TODO list 2021-07-30 23:55:08 -07:00
api.lua Minor changes to Lua docstrings 2021-07-30 18:09:00 -07:00
changelog.txt Add chat command to find names of nearby nodes 2021-07-31 01:19:52 -07:00
chat.lua Add chat command to find names of nearby nodes 2021-07-31 01:19:52 -07:00
entities.lua
init.lua Move pencil into tools.lua 2021-07-29 13:38:10 -07:00
items.lua
misc_functions.lua Fix missing sound_hand declaration 2021-07-31 01:11:12 -07:00
mod.conf
nodes.lua
ores.lua
screenshot.png Add screenshot 2021-07-30 23:20:45 -07:00
settings.lua Add some details to settings docstrings 2021-07-30 16:15:52 -07:00
settingtypes.txt Add some details to settings docstrings 2021-07-30 16:15:52 -07:00
tools.lua Fix missing sound_hand declaration 2021-07-31 01:11:12 -07:00

README.md

Cleaner mod for Minetest

Description:

A Minetest mod that can be used to remove/replace unknown entities, nodes, & items. Originally forked from PilzAdam's clean mod.

screenshot

Licensing:

  • Code: MIT
  • Textures: CC0
  • Sounds:
    • cleaner_pencil_write: CC0
    • cleaner_pencil_erase: CC0

Requirements:

  • Minetest minimum version: 5.0
  • Depends: none

Usage:

Registering items, entities, etc. for cleaning can be done in cleaner.json in the world directory. If it does not exist it will be created automatically when the server is started.

It is formatted as follows:

{
	"entities" :
	{
		"remove" : []
	},
	"items" :
	{
		"replace" : {}
	},
	"nodes" :
	{
		"remove" : [],
		"replace" : {}
	},
	"ores" :
	{
		"remove" : []
	}
}

Cleaning nodes example:

{
	"nodes" :
	{
		"remove" : [
			"old:node_1",
			"old:node_2",
		],
		"replace" : {
			"old:node_3" : "new:node_1",
			"old:node_4" : "new:node_2",
		}
	},
}

remove key works for nodes, entities, & ores. replace key works for nodes & items. Their functions are self-explanatory.

Settings:

cleaner.unsafe
- Enables unsafe methods & commands (remove_ore).
- type:    bool
- default: false