[Mod] Cleaner [cleaner]

[AntumDeluge]

Cleaner - Remove Unknown Entities, Nodes, & Items

Description:

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



Licensing:

• Code: MIT
• Textures: CC0

Requirements:

• Minetest 0.4.16 or newer
• Depends: none

Usage:

There are three files in the world path that can be edited: clean_entities.json, clean_nodes.json, & clean_items.json. If they do not already exist when the server is started they will be created automatically.

They are formatted as follows:

Code: Select all

{
  "remove":
  [
    "creatures:ghost",
    "creatures:sheep",
  ],
  "replace":
  {
    "biofuel:biofuel":"default:leaves",
    "helicopter:heli":"default:copper_lump",
    "unifieddyes:airbrush":"default:coal_lump",
  },
}

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

Links:

• Git repo
• Reference (added in v1.2)
• Changelog
• TODO
• PilzAdam's original clean mod:
  • Forum
  • code (Jun 08, 2013)

Releases:

• 

[John_Constructor]

This might be helpful! Definitely for those who have an ore mod and might want to disable it for their world.

[azekill_DIABLO]

+1 definitivly needed

[IanniPowerup!!!]

doesnt work :(

[Grizzly Adam]

Does work. Thank you.

[neko259]

It would be better to add not only nodes to remove but node substitutes too. Sometimes a node was renamed or moved to other mod and can be simply replaced.

[mase]

How can I get rid of whole node or entity groups, for example all zombies,
or all kind of trails from the trails mod?

[bell07]

Please use register_lbm with run_at_every_load instead of register_abm to clean nodes. Should use less ressources.

[AntumDeluge]

Thank you bell07. I will check that out.

[mase]

Does this mod remove all unknown objects on server start, or only when a player is near?

[AntumDeluge]

Does this mod remove all unknown objects on server start, or only when a player is near?

As I understand it, only when a player is near. But it's been a while since I looked at the code.

[AntumDeluge]

Please use register_lbm with run_at_every_load instead of register_abm to clean nodes. Should use less ressources.

Added to my TODO list. I am active again.

[AntumDeluge]

It would be better to add not only nodes to remove but node substitutes too. Sometimes a node was renamed or moved to other mod and can be simply replaced.

Done.

[AntumDeluge]

Please use register_lbm with run_at_every_load instead of register_abm to clean nodes. Should use less ressources.

Done: 2c127af

[Alatarius]

Can you use wildcards with this, for example, mobs_animal:*

I only ask this specifically because I uninstalled the mobs_animal mod from TenPlus1 and now I have well over 50 entities to remove. And to have to go through this that many times is undoable but my server has become so big that it can't be deleted and it was a group decision to use a new animal mod.

[Slightly]

Can you use wildcards with this, for example, mobs_animal:*

I only ask this specifically because I uninstalled the mobs_animal mod from TenPlus1 and now I have well over 50 entities to remove.

When I removed animals from the mobs_animal mod in my singleplayer, I added lines like this to the init file and it worked great. I would probably put in the mod temporarily with the files for animals commented out and lines like this added.

mobs:alias_mob("mobs_animal:sheep_white", "default:air")
I also used it to replace animals with mobs I was keeping and that seemed to work better than the "air" version.
mobs:alias_mob("petz:bee", "mobs_animal:chicken")
Ham-fisted, I know, but it worked well for me.

[Blockhead]

A user on the Minetest Matrix today asked about this mod:

Hello,
Are ore nodes different from other nodes such as wood or dirt ?
I am asking because in the "cleaner" mod, removing them is "unsafe".

After investigating the source, my response was

Cleaner's "remove ore" function (/remove_ore or Lua cleaner.remove_ore() removes the ore spawns from the world generation, it doesn't remove any nodes

This could be unsafe because it could be detrimental to gameplay or since it removes table entries from minetest.registered_ores that other mods might have a reference to.

I hope this helps anyone who is wondering about this part of the mod.

[RobotLuanti123]

Is there a way to clean out the unknown node blocks off the entire world? Because I'm using the .json file and it seems to just be erasing bits and pieces here and there and not the nodes away from the whole world.

[Blockhead]

Is there a way to clean out the unknown node blocks off the entire world? Because I'm using the .json file and it seems to just be erasing bits and pieces here and there and not the nodes away from the whole world.

The way this mod works is at the in-game level, where when the requested nodes are loaded into the world, they get removed. You need a solution that runs on the whole world database at once. I've tried looking for a tool like that - I could have sworn sorcerykid had something - but all I could really find is something that doesn't act on a fundamentally different basis, namely, Server Cleaner, which additionally can clean up excess players.

The basic idea is an external tool that connects to the world database, deserialises every mapblock that has the relevant nodes in it, replaces them, reserialises the mapblock, and writes it back to the database. The tool also needs to support the database backend used, which isn't 100% guaranteed to be SQLite for some servers, and it needs to support zstd compression for recent worlds – 5.5.0 moved from deflate to zstd.