diff --git a/README b/README new file mode 100644 index 0000000..874fe6f --- /dev/null +++ b/README @@ -0,0 +1,52 @@ +# Townchest + +A minetest mod contains a chest with building definitions. The chest can spawn a NPC that does build the building for you. + +## Features + +- WorldEdit file target + - A Chest that allows you to choose a building and manage the building options + - The most WorldEdit files are supported. just put the file to the buildings directory + - Flatting and cleanup the building place, remove all cruft-nodes from building inside + - Cleanup unknown nodes + - Ground level detection trough dirt_with_* nodes + - Optimized for realy big buildings. Try the AMMOnym_coloseum.we as a showcase + +- Creative build + - Instant build allow you to get the building instantly + - Creative build by NPC without providing needed nodes + +- Builder-NPC's + - Multiple NPC's per building can be used (to get Clolseum in time you need ~50 NPC's oO) + - NPC can change the assigned building if chest is stopped and an other active chest nearly + +## Roadmap (not implemented yet) +- Survival mode + - each NPC gets own inventory + - build a node only if there is place in inventory for the old one and the new one is avialable in inventory + - Use all nearly default:chest to store removed nodes (flatting) and to get nodes for building + +- Node mapping support + - a way to change the needed nodes (like in building defined default:wood but I like to use something from moretrees mod) + - the mapping should be able to map the unknown nodes + +- Support mts files + +## Vision / Ideas / maybe +- other chests that generates a plan. The generated plan can be the daily work of a lumberjack as example + +## Credits +- cornernote - made the towntest mod that was used as template for townchest +- PilzAdam - made the initial NPC entity movement code (towntest) +- VanessaE - contributed buildings (towntest) +- kddekadenz - contributed buildings (towntest) +- ACDC - contributed buildings (towntest) +- Nanuk - contributed buildings (towntest) +- irksomeduck - contributed buildings (towntest) +- AMMOnym_coloseum.we https://forum.minetest.net/viewtopic.php?p=121294#p121294 +- PEAK_BremerHaus.we https://forum.minetest.net/viewtopic.php?p=207103#p207103 +- All contributions welcome! + + +## License +BSD-3-Clause diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..bfa05ba Binary files /dev/null and b/screenshot.png differ