modcleaner/README.md

87 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2025-01-18 02:27:49 -08:00
## Cleaner mod for Luanti
2021-05-18 17:46:18 -07:00
### Description:
2025-01-18 02:27:49 -08:00
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].
2021-05-26 21:25:02 -07:00
2021-07-30 23:20:45 -07:00
![screenshot](screenshot.png)
2021-05-26 21:25:02 -07:00
### Licensing:
- Code: [MIT](LICENSE.txt)
- Textures: CC0
2021-05-18 17:46:18 -07:00
### Requirements:
2017-08-30 15:16:14 -07:00
2025-01-18 02:27:49 -08:00
- Luanti minimum version: 5.0
2017-08-30 15:16:14 -07:00
- Depends: none
2021-05-26 21:25:02 -07:00
### Usage:
2021-07-12 18:21:25 -07:00
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.
2021-05-26 21:25:02 -07:00
2021-07-12 18:21:25 -07:00
It is formatted as follows:
2021-05-26 21:25:02 -07:00
```json
{
2021-07-12 18:21:25 -07:00
"entities" :
2021-05-26 21:25:02 -07:00
{
2021-07-12 18:21:25 -07:00
"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",
}
2021-05-26 21:25:02 -07:00
},
}
```
2021-07-12 18:21:25 -07:00
`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
```
2021-05-26 21:25:02 -07:00
### Links:
2025-01-18 02:27:49 -08:00
- [![ContentDB](https://content.luanti.org/packages/AntumDeluge/cleaner/shields/title/)][ContentDB]
- [Forum](https://forum.luanti.org/viewtopic.php?t=18381)
2021-05-26 21:25:02 -07:00
- [Git repo](https://github.com/AntumMT/mod-cleaner)
- [Reference](https://antummt.github.io/mod-cleaner/reference/latest/)
2021-05-26 21:25:02 -07:00
- [Changelog](changelog.txt)
- [TODO](TODO.txt)
2025-01-18 02:27:49 -08:00
[Luanti]: https://luanti.org/
[f.pilzadam]: https://forum.luanti.org/viewtopic.php?t=2777
[ContentDB]: https://content.luanti.org/packages/AntumDeluge/cleaner/