Cleaner (v1.2)

• Index

Contents

• Chat Commands
• Unsafe Commands

Topics

• settings
• api
• commands
• tools
• config

Topic commands

Cleaner Chat Commands

Chat Commands

remove_entities <entity> [radius]	Removes nearby entities.
remove_nodes <node> [radius]	Removes nearby nodes.
replace_items <old_item> <new_item>	Replaces an item.
replace_nodes <old_node> <new_node> [radius]	Replaces nearby nodes.
find_unknown_nodes [radius]	Checks for nearby unknown nodes.
find_nearby_nodes [radius]	Finds names of nearby nodes.
ctool <action> <value>	Manages settings for wielded cleaner tool.

Unsafe Commands

remove_ores <ore>

Registers an ore to be removed.

Chat Commands

remove_entities <entity> [radius]

Removes nearby entities.

Parameters:

• entity Entity technical name.
• radius int Search radius (default: 100). (optional)

Required Privileges:

• server

Usage:

# remove all mobs:horse entities within a radius of 10 nodes
/remove_entities mobs:horse 10

remove_nodes <node> [radius]

Removes nearby nodes.

Parameters:

• node Node technical name.
• radius int Search radius (default: 5). (optional)

Required Privileges:

• server

Usage:

# remove all default:dirt nodes within a radius of 10
/remove_nodes default:dirt 10

replace_items <old_item> <new_item>

Replaces an item.

Parameters:

• old_item Technical name of item to replace.
• new_item Technical name of item to be used in place.

Required Privileges:

• server

Usage:

# replace default:sword_wood with default:sword_mese
/replace_items default:sword_wood default:sword_mese

replace_nodes <old_node> <new_node> [radius]

Replaces nearby nodes.

Parameters:

• old_node Technical name of node to replace.
• new_node Technical name of node to be used in place.
• radius int Search radius (default: 5). (optional)

Required Privileges:

• server

Usage:

# replace all default:dirt nodes with default:cobble within a radius of 10
/replace_nodes default:dirt default:cobble 10

find_unknown_nodes [radius]

Checks for nearby unknown nodes.

Parameters:

• radius int Search radius (default: 100). (optional)

Required Privileges:

• server

Usage:

# print names of all unknown nodes within radius of 10
/find_unknown_nodes 10

find_nearby_nodes [radius]

Finds names of nearby nodes.

Parameters:

• radius int Search radius (default: 5). (optional)

Required Privileges:

• server

Usage:

# print names of all node types found within radius of 10
/find_nearby_nodes 10

ctool <action> <value>

Manages settings for wielded cleaner tool.

Required Privileges:

• server

Parameters:

• action Action to execute. Can be "status", "setmode", or "setnode".
• value Mode or node to be set for tool (not required for "status" action).

Usage:

# while cleaner:pencil is wielded, configure to place default:dirt node when used
/ctool setmode write
/ctool setnode default:dirt

Unsafe Commands

remove_ores <ore>

Registers an ore to be removed.

Parameters:

• ore Ore technical name.

Required Privileges:

• server

Notes:

• This action is reverted after server restart. To make changes permanent, use the cleaner.json config.

Usage:

# remove all registered ores that add default:stone_with_iron to world
/remove_ores default:stone_with_iron