Add a README.

master
Aaron Suen 2019-12-30 10:47:33 -05:00
parent 8f54ea20f5
commit 21b9b595bd
1 changed files with 23 additions and 0 deletions

23
README Normal file
View File

@ -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.
------------------------------------------------------------------------
========================================================================