From baa10c7a006f3bdd6ab2b916f05797e01a63d1c2 Mon Sep 17 00:00:00 2001
From: Philipp Sehmisch <tmw@crushnet.org>
Date: Thu, 22 May 2008 01:53:16 +0000
Subject: Added descriptive comments to all particle effect files.

---
 graphics/particles/attack.particle.xml          | 5 +++++
 graphics/particles/circle.particle.xml          | 4 ++++
 graphics/particles/colorful-orbits.particle.xml | 7 ++++++-
 graphics/particles/cookingfire.particle.xml     | 5 +++++
 graphics/particles/fireplace.particle.xml       | 5 +++++
 graphics/particles/flame.particle.xml           | 6 ++++++
 graphics/particles/fountain.particle.xml        | 4 +++-
 graphics/particles/hit.particle.xml             | 4 ++++
 graphics/particles/levelup.particle.xml         | 4 +++-
 graphics/particles/nomadpipe.particle.xml       | 5 +++++
 graphics/particles/playerglow.particle.xml      | 6 +++++-
 graphics/particles/skillup.particle.xml         | 4 +++-
 graphics/particles/snow.particle.xml            | 5 ++++-
 graphics/particles/soulmenhir.particle.xml      | 6 +++++-
 graphics/particles/waterfall.particle.xml       | 5 ++++-
 graphics/particles/whirlpool.particle.xml       | 4 +++-
 16 files changed, 70 insertions(+), 9 deletions(-)

diff --git a/graphics/particles/attack.particle.xml b/graphics/particles/attack.particle.xml
index f0ba8d7f..9b60c17a 100644
--- a/graphics/particles/attack.particle.xml
+++ b/graphics/particles/attack.particle.xml
@@ -1,5 +1,10 @@
 <?xml version="1.0"?>
 
+<!--
+A burst of red particles emitted in a narrow, horizontal cone. Could be
+used to visualize some kind of special attack.
+-->
+
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/circle.particle.xml b/graphics/particles/circle.particle.xml
index 900bc834..2884ced2 100644
--- a/graphics/particles/circle.particle.xml
+++ b/graphics/particles/circle.particle.xml
@@ -1,5 +1,9 @@
 <?xml version="1.0"?>
 
+<!--
+A circle on the ground 60 pixels in diameter made from particles.
+-->
+
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/colorful-orbits.particle.xml b/graphics/particles/colorful-orbits.particle.xml
index dea0de7a..25786f8f 100644
--- a/graphics/particles/colorful-orbits.particle.xml
+++ b/graphics/particles/colorful-orbits.particle.xml
@@ -1,7 +1,12 @@
 <?xml version="1.0"?>
 
 <!--
-Want it bigger or smaller? When you half the orbit (distance) just double the acceleration and vice versa.
+6 differently colored objects which orbit around a centerpoint in different
+circular orbits forming a sphere. Beautiful but I can't imagine any application
+for this effect as it is. It is basically a proof of concept.
+
+Want it bigger or smaller? When you half the orbit (distance) just double the
+acceleration and vice versa.
 -->
 <effect>
 	<particle
diff --git a/graphics/particles/cookingfire.particle.xml b/graphics/particles/cookingfire.particle.xml
index 899b37ec..6f00a38b 100644
--- a/graphics/particles/cookingfire.particle.xml
+++ b/graphics/particles/cookingfire.particle.xml
@@ -1,5 +1,10 @@
 <?xml version="1.0"?>
 
+<!--
+A fire at the ground and some steam above it designed for use with the brass
+cauldron from the woodland_indoor tileset.
+-->
+
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/fireplace.particle.xml b/graphics/particles/fireplace.particle.xml
index 0bd8242c..fb1cdb3f 100644
--- a/graphics/particles/fireplace.particle.xml
+++ b/graphics/particles/fireplace.particle.xml
@@ -1,5 +1,10 @@
 <?xml version="1.0"?>
 
+<!--
+A one tile wide rectangular fire effect intended for use with the fireplace
+from the woodland_indoor tileset.
+-->
+
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/flame.particle.xml b/graphics/particles/flame.particle.xml
index 6d9e72d8..df735a1a 100644
--- a/graphics/particles/flame.particle.xml
+++ b/graphics/particles/flame.particle.xml
@@ -1,5 +1,11 @@
 <?xml version="1.0"?>
 
+<!--
+Small flame with a point-like source designed for the lamps on the cave
+tileset but it should also work to visualize some kind of torch or - when
+launched by a parent emitter - a small fireball.
+-->
+
 <effect>
 	<particle
 		position-x = "17"
diff --git a/graphics/particles/fountain.particle.xml b/graphics/particles/fountain.particle.xml
index 5140e28b..2a135d91 100644
--- a/graphics/particles/fountain.particle.xml
+++ b/graphics/particles/fountain.particle.xml
@@ -1,5 +1,7 @@
 <?xml version="1.0"?>
-
+<!--
+Fancy fireworks effect which fills the whole screen.
+-->
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/hit.particle.xml b/graphics/particles/hit.particle.xml
index 4a7c009b..03843c72 100644
--- a/graphics/particles/hit.particle.xml
+++ b/graphics/particles/hit.particle.xml
@@ -1,5 +1,9 @@
 <?xml version="1.0"?>
 
+<!--
+An explosion of white particles.
+-->
+
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/levelup.particle.xml b/graphics/particles/levelup.particle.xml
index 5d22343b..32f3ccb9 100644
--- a/graphics/particles/levelup.particle.xml
+++ b/graphics/particles/levelup.particle.xml
@@ -1,5 +1,7 @@
 <?xml version="1.0"?>
-
+<!--
+Red stars which are supposed to engulf a character
+-->
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/nomadpipe.particle.xml b/graphics/particles/nomadpipe.particle.xml
index fc8973eb..703c823b 100644
--- a/graphics/particles/nomadpipe.particle.xml
+++ b/graphics/particles/nomadpipe.particle.xml
@@ -1,5 +1,10 @@
 <?xml version="1.0"?>
 
+<!--
+Small smoke puffs emitted in irregular pulses. Designed for the pipe of the
+nomad NPC.
+-->
+
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/playerglow.particle.xml b/graphics/particles/playerglow.particle.xml
index e0de0c4e..57779248 100644
--- a/graphics/particles/playerglow.particle.xml
+++ b/graphics/particles/playerglow.particle.xml
@@ -1,5 +1,9 @@
 <?xml version="1.0"?>
-
+<!--
+Proof of concept of animated stationary particle effects (a bat ) and some
+orbiting yellow particles. Rather useless but could be used as a template for
+more useful status effect particle effects.
+-->
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/skillup.particle.xml b/graphics/particles/skillup.particle.xml
index 09a512e2..54b2c7c5 100644
--- a/graphics/particles/skillup.particle.xml
+++ b/graphics/particles/skillup.particle.xml
@@ -1,5 +1,7 @@
 <?xml version="1.0"?>
-
+<!--
+Green stars which are supposed to engulf a character
+-->
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/snow.particle.xml b/graphics/particles/snow.particle.xml
index e54f6f70..ce8c6391 100644
--- a/graphics/particles/snow.particle.xml
+++ b/graphics/particles/snow.particle.xml
@@ -1,5 +1,8 @@
 <?xml version="1.0"?>
-
+<!--
+Snowflakes which cover 200x200 tiles which is enough for most reasonably-sized
+maps. Most people think it sucks.
+-->
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/soulmenhir.particle.xml b/graphics/particles/soulmenhir.particle.xml
index 3d964c3d..77ac0b92 100644
--- a/graphics/particles/soulmenhir.particle.xml
+++ b/graphics/particles/soulmenhir.particle.xml
@@ -1,5 +1,9 @@
 <?xml version="1.0"?>
-
+<!--
+Light blue particles which fly up to the sky. About one tile wide, three tiles
+high and supposed to give an object which is about half as large as a player
+character some magical aura.
+-->
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/waterfall.particle.xml b/graphics/particles/waterfall.particle.xml
index 42eb87a7..b2b93655 100644
--- a/graphics/particles/waterfall.particle.xml
+++ b/graphics/particles/waterfall.particle.xml
@@ -1,5 +1,8 @@
 <?xml version="1.0"?>
-
+<!--
+A waterfall viewed from the front with some steam at the bottom. A little more
+than one tile wide and about 3 tiles high.
+-->
 <effect>
 	<particle
 		position-x = "0"
diff --git a/graphics/particles/whirlpool.particle.xml b/graphics/particles/whirlpool.particle.xml
index 98715253..159ebd6a 100644
--- a/graphics/particles/whirlpool.particle.xml
+++ b/graphics/particles/whirlpool.particle.xml
@@ -1,5 +1,7 @@
 <?xml version="1.0"?>
-
+<!--
+White bubbles which come out of the ground and fill exactly one tile.
+-->
 <effect>
 	<particle
 		position-x = "0"
-- 
cgit v1.2.3-60-g2f50