From 4d6e79b07f467fc7e2b38967ca77816b2bf312df Mon Sep 17 00:00:00 2001
From: AFCMS <afcm.contact@gmail.com>
Date: Mon, 24 Oct 2022 23:50:16 +0200
Subject: [PATCH] Rewrite mcl_dripping README to Markdown, add API exemple and
 update infos

---
 mods/ENTITIES/mcl_dripping/README.md  | 36 +++++++++++++++++++++++++++
 mods/ENTITIES/mcl_dripping/readme.txt | 29 ---------------------
 2 files changed, 36 insertions(+), 29 deletions(-)
 create mode 100644 mods/ENTITIES/mcl_dripping/README.md
 delete mode 100644 mods/ENTITIES/mcl_dripping/readme.txt

diff --git a/mods/ENTITIES/mcl_dripping/README.md b/mods/ENTITIES/mcl_dripping/README.md
new file mode 100644
index 000000000..d6ff75ff1
--- /dev/null
+++ b/mods/ENTITIES/mcl_dripping/README.md
@@ -0,0 +1,36 @@
+# mcl_dripping
+
+Dripping Mod by kddekadenz, modified for MineClone 2 by Wuzzy, NO11 and AFCM
+
+## Manual
+
+- drops are generated rarely under solid nodes
+- they will stay some time at the generated block and than they fall down
+- when they collide with the ground, a sound is played and they are destroyed
+
+Water and Lava have builtin drops registered.
+
+## License
+
+code & sounds: CC0
+
+## API
+
+```lua
+mcl_dripping.register_drop({
+	-- The group the liquid's nodes belong to
+	liquid   = "water",
+	-- The texture used (particles will take a random 2x2 area of it)
+	texture  = "default_water_source_animated.png",
+	-- Define particle glow, ranges from `0` to `minetest.LIGHT_MAX`
+	light    = 1,
+	-- The nodes (or node group) the particles will spawn under
+	nodes    = { "group:opaque", "group:leaves" },
+	-- The sound that will be played then the particle detaches from the roof, see SimpleSoundSpec in lua_api.txt
+	sound    = "drippingwater_drip",
+	-- The interval for the ABM to run
+	interval = 60,
+	-- The chance of the ABM
+	chance   = 10,
+})
+```
diff --git a/mods/ENTITIES/mcl_dripping/readme.txt b/mods/ENTITIES/mcl_dripping/readme.txt
deleted file mode 100644
index afe35608e..000000000
--- a/mods/ENTITIES/mcl_dripping/readme.txt
+++ /dev/null
@@ -1,29 +0,0 @@
-Dripping Mod
-by kddekadenz
-
-modified for MineClone 2 by Wuzzy and NO11
-
-
-Installing instructions:
-
-	1. Copy the mcl_dripping mod folder into games/gamemode/mods
-
-	2. Start game and enjoy :)
-
-
-Manual:
-
--> drops are generated rarely under solid nodes
--> they will stay some time at the generated block and than they fall down
--> when they collide with the ground, a sound is played and they are destroyed
-
-
-License:
-
-code & sounds: CC0
-
-
-Changelog:
-
-16.04.2012 - first release
-28.04.2012 - drops are now 3D; added lava drops; fixed generating of drops (not at edges now)