From 21b9b595bdf129b1e53d172d43d5ff070bb842a3 Mon Sep 17 00:00:00 2001 From: Aaron Suen Date: Mon, 30 Dec 2019 10:47:33 -0500 Subject: [PATCH] Add a README. --- README | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..0a00d87 --- /dev/null +++ b/README @@ -0,0 +1,23 @@ +======================================================================== +Minetest Advanced Particle Spawner Proof-of-Concept +------------------------------------------------------------------------ + +This is a pure server-side lua implementation of a proposed API for +advanced particles spanwers for Minetest, which allows some particle +effects to be achieved that are not possible with the existing particle +spawners. + +The behavior defined by the API in this mod is currently implemented by +sending a swarm of add_particle packets to the client (individually for +each particle) BUT it could be done much more efficiently in the engine +by sending a single add_particlespawner_advanced packet to the client. + +Included are a bunch of demo nodes, each of which creates a special +particle effect that cannot be achieved with ordinary particlspawners +every 2 seconds. Use a /giveme command to give yourself demo nodes: + /giveme advparticles:demo# +...where # is 1, 2, 3, etc. Place the node to see the effect created +around that node. Punch to remove. + +------------------------------------------------------------------------ +========================================================================