README.md

@@ -1,14 +1,38 @@
-# PK_Alert
+# PKAdmin
-Notify to channel PK alert information.
 
-pkadmin help            :    This menu
+## Usage:
 
-pkadmin alert <yes/no>  :    Turns on/off channel alerts             
+   pkadmin help                :      This menu
 
-pkadmin sound <yes/no>  :    Turns on/off sound alerts               
+   pkadmin alert <yes/no>      :      Turns on/off channel alerts
 
-pkadmin volume <0-100>  :    Sets the play volume for sound          
+   pkadmin sound <yes/no>      :      Turns on/off sound alerts
 
-pkadmin enable          :    Enables the script                      
+   pkadmin volume <0-100>      :      Sets the play volume for sound
 
-pkadmin disable         :    Disables the script
+   pkadmin levelrange <1-100>  :      Set the range of levels displayed in the PK Alert
+
+   pkadmin enable              :      Enables the script
+
+   pkadmin disable             :      Disables the script
+
+   pkgo                        :      "Runto" help your clan mate out
+
+
+## Installation:
+Copy the sound file redalert.wav into your MUSHclient\sounds directory.
+
+Copy the xml file into your MUSHclient\worlds\plugins diretory or a subdirectory.
+Then just install the plugin into MUSHClient and you are ready to go.
+
+Usage
+At the end of the PK alert message is the level of the player being attacked
+and a level range. The level range defaults to plus and minus 10. It can be
+changed to any value with tht epkadmin levelrange command.
+
+When you see a PK Alert from a clan mate, the second line that is displayed
+has a clickable link for the room number. If you have explored the room and all
+necessary cexits are setup you will run directly to the room.
+
+There is also a handy alias pkgo that will again run you to the room of your
+clan mate. It is reset each time the PK alert is displayed on your screen.