Go to file
Jordan Irwin 657ba25890 Add screenshot 2021-07-30 23:20:45 -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 Add pencil tool for erasing, adding, & swapping nodes 2021-07-28 01:39:38 -07:00
sounds_src Add sound sources used to created OGG files 2021-07-29 12:42:08 -07:00
textures Add pencil tool for erasing, adding, & swapping nodes 2021-07-28 01:39:38 -07:00
.gitattributes Add git attributes to exclude some dirs & files from releases 2021-07-30 23:16:37 -07:00
LICENSE.txt Change license to MIT 2021-05-18 17:46:18 -07:00
README.md Add screenshot 2021-07-30 23:20:45 -07:00
TODO.txt Change "cleaner" chat command to "ctool" 2021-07-30 16:30:52 -07:00
api.lua Minor changes to Lua docstrings 2021-07-30 18:09:00 -07:00
changelog.txt Change "cleaner" chat command to "ctool" 2021-07-30 16:30:52 -07:00
chat.lua Minor changes to Lua docstrings 2021-07-30 18:09:00 -07:00
entities.lua use single json file for cleaning all types 2021-07-12 18:09:54 -07:00
init.lua Move pencil into tools.lua 2021-07-29 13:38:10 -07:00
items.lua Add remove_item function to API 2021-07-12 23:44:28 -07:00
misc_functions.lua Add/update localization strings 2021-07-30 15:29:26 -07:00
mod.conf Add localization support... 2021-07-12 20:02:03 -07:00
nodes.lua Use more appropriate node swapping 2021-07-27 16:58:33 -07:00
ores.lua add support for unregistering ores via world path file 2021-07-12 18:11:37 -07:00
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 Move pencil into tools.lua 2021-07-29 13:38:10 -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