https://github.com/antummt/mod-cleaner
Clean up your Minetest world
https://github.com/antummt/mod-cleaner
game game-mod minetest minetest-mod mod
Last synced: 2 months ago
JSON representation
Clean up your Minetest world
- Host: GitHub
- URL: https://github.com/antummt/mod-cleaner
- Owner: AntumMT
- License: mit
- Created: 2017-05-18T22:06:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-18T11:03:45.000Z (3 months ago)
- Last Synced: 2025-01-30T20:27:51.934Z (3 months ago)
- Topics: game, game-mod, minetest, minetest-mod, mod
- Language: Lua
- Homepage: https://content.minetest.net/packages/AntumDeluge/cleaner/
- Size: 589 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- License: LICENSE.txt
Awesome Lists containing this project
README
## Cleaner mod for Luanti
### Description:
A [Luanti (Minetest)][Luanti] mod that can be used to remove/replace unknown entities, nodes, & items. Originally forked from [PilzAdam's ***clean*** mod][f.pilzadam].
### Licensing:
- Code: [MIT](LICENSE.txt)
- Textures: CC0
### Requirements:
- Luanti 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:
```json
{
"entities" :
{
"remove" : []
},
"items" :
{
"replace" : {}
},
"nodes" :
{
"remove" : [],
"replace" : {}
},
"ores" :
{
"remove" : []
}
}
```
Cleaning nodes example:
```json
{
"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
```
### Links:
- [][ContentDB]
- [Forum](https://forum.luanti.org/viewtopic.php?t=18381)
- [Git repo](https://github.com/AntumMT/mod-cleaner)
- [Reference](https://antummt.github.io/mod-cleaner/reference/latest/)
- [Changelog](changelog.txt)
- [TODO](TODO.txt)
[Luanti]: https://luanti.org/
[f.pilzadam]: https://forum.luanti.org/viewtopic.php?t=2777
[ContentDB]: https://content.luanti.org/packages/AntumDeluge/cleaner/