From a59930d0d425247ec1b2adcf7a00b94767f1e622 Mon Sep 17 00:00:00 2001
From: Major- <major@emulate.rs>
Date: Fri, 8 Aug 2014 14:36:56 +0100
Subject: [PATCH] Add npcs to Al-Kharid.

---
 data/plugins/location/al-kharid/npcs.rb    | 61 +++++++++++++++++++---
 data/plugins/location/al-kharid/plugin.xml | 16 ++++++
 2 files changed, 69 insertions(+), 8 deletions(-)
 create mode 100644 data/plugins/location/al-kharid/plugin.xml

diff --git a/data/plugins/location/al-kharid/npcs.rb b/data/plugins/location/al-kharid/npcs.rb
index cb088d85..8c63dd0e 100644
--- a/data/plugins/location/al-kharid/npcs.rb
+++ b/data/plugins/location/al-kharid/npcs.rb
@@ -1,9 +1,54 @@
+# Information about npc spawning
+#
+# Npcs are passed to spawn npc as a hash. Every key and every non-integer value must be a Symbol. Every hash must implement the following:
+#   :name or :id - the name or the id of the npc. Use of :name is recommended. If this npc shares its name with another, append the specific id after the name (e.g. :woman_4)
+#   :x - the x coordinate where the npc will spawn.
+#   :y - the y coordinate where the npc will spawn.
+# Optional arguments are as follows:
+#   :face - the direction the npc should face when it spawns. Supported options are :north, :north_east, :east, :south_east, :south, :south_west, :west, and :north_west
+#   :bounds - the rectangular bound that the npc can wander about in. Order is [top-left x-coordinate, top-left y-coordinate, bottom-right x-coordinate, bottom-right y-coordinate]
+#   :delta_bounds - the rectangular bound that the npc can wander about in, as a difference from the spawn point. Order is [x-delta, y-delta]. Should not be used with :bounds.
+#   :spawn_animation - the animation that will be played when the npc spawns.
+#   :spawn_graphic - the graphic that will be played when the npc spawns.
 
-spawn_npc :name => :gem_trader,          :x => 3287, :y => 3210, :face => :south
-spawn_npc :name => :al_karid_warrior_18, :x => 3288, :y => 3169
-spawn_npc :name => :al_karid_warrior_18, :x => 3295, :y => 3170
-spawn_npc :name => :al_karid_warrior_18, :x => 3297, :y => 3175
-spawn_npc :name => :al_karid_warrior_18, :x => 3300, :y => 3171
-spawn_npc :name => :al_karid_warrior_18, :x => 3301, :y => 3168
-spawn_npc :name => :al_karid_warrior_18, :x => 3301, :y => 3164
-spawn_npc :name => :al_karid_warrior_18, :x => 3295, :y => 3162
\ No newline at end of file
+
+# Generic npcs
+
+spawn_npc :name => :man, :x => 3276, :y => 3186
+
+spawn_npc :name => "Al-Kharid warrior", :x => 3283, :y => 3161 # String must be used here because the actual npc name is 'Al-Kharid warrior', and symbols don't support hyphens.
+spawn_npc :name => "Al-Kharid warrior", :x => 3285, :y => 3174
+spawn_npc :name => "Al-Kharid warrior", :x => 3286, :y => 3164
+spawn_npc :name => "Al-Kharid warrior", :x => 3287, :y => 3168
+spawn_npc :name => "Al-Kharid warrior", :x => 3288, :y => 3169
+spawn_npc :name => "Al-Kharid warrior", :x => 3290, :y => 3162
+spawn_npc :name => "Al-Kharid warrior", :x => 3295, :y => 3162
+spawn_npc :name => "Al-Kharid warrior", :x => 3295, :y => 3170
+spawn_npc :name => "Al-Kharid warrior", :x => 3297, :y => 3175
+spawn_npc :name => "Al-Kharid warrior", :x => 3300, :y => 3171
+spawn_npc :name => "Al-Kharid warrior", :x => 3301, :y => 3164
+spawn_npc :name => "Al-Kharid warrior", :x => 3301, :y => 3168
+
+spawn_npc :name => :shantay_guard,     :x => 3304, :y => 3119
+spawn_npc :name => :shantay_guard_838, :x => 3301, :y => 3120
+spawn_npc :name => :shantay_guard_838, :x => 3307, :y => 3122
+
+# Functional npcs
+
+spawn_npc :name => :gem_trader, :x => 3287, :y => 3210
+spawn_npc :name => :shantay,    :x => 3304, :y => 3124
+
+spawn_npc :name => :rug_merchant_2296, :x => 3311, :y => 3109, :face => :west
+
+spawn_npc :name => :banker_496, :x => 3267, :y => 3164, :face => :east # TODO are these the correct banker ids?
+spawn_npc :name => :banker_497, :x => 3267, :y => 3166, :face => :east
+spawn_npc :name => :banker_496, :x => 3267, :y => 3167, :face => :east
+spawn_npc :name => :banker_497, :x => 3267, :y => 3168, :face => :east
+spawn_npc :name => :banker_496, :x => 3267, :y => 3169, :face => :east
+
+spawn_npc :name => :zeke,       :x => 3289, :y => 3189
+spawn_npc :name => :ranael,     :x => 3315, :y => 3163, :face => :north
+spawn_npc :name => :louie_legs, :x => 3316, :y => 3175, :face => :west
+
+spawn_npc :name => :shop_assistant_525, :x => 3315, :y => 3178, :face => :north # TODO are these the correct shop staff ids?
+spawn_npc :name => :shop_keeper_524,    :x => 3315, :y => 3180, :face => :west
\ No newline at end of file
diff --git a/data/plugins/location/al-kharid/plugin.xml b/data/plugins/location/al-kharid/plugin.xml
new file mode 100644
index 00000000..64a10ed9
--- /dev/null
+++ b/data/plugins/location/al-kharid/plugin.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<plugin>
+  <id>location-al-kharid</id>
+  <version>0.1</version>
+  <name>Al-Kharid</name>
+  <description>Adds functionality to Al-Kharid.</description>
+  <authors>
+    <author>Major</author>
+  </authors>
+  <scripts>
+    <script>npcs.rb</script>
+  </scripts>
+  <dependencies>
+    <dependency>entity-spawning</dependency>
+  </dependencies>
+</plugin>
\ No newline at end of file