From 538949fdb8b92306c3d3d9e1ccd330ddde66a595 Mon Sep 17 00:00:00 2001 From: Zafrusteria Date: Tue, 12 May 2020 12:03:14 -0400 Subject: [PATCH] Updated reamed with help and install instructions --- README.md | 40 ++++++++++++++++++++++++++++++++-------- 1 file changed, 32 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 78a860e..beda454 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,38 @@ -# PK_Alert -Notify to channel PK alert information. +# PKAdmin -pkadmin help : This menu +## Usage: -pkadmin alert : Turns on/off channel alerts + pkadmin help : This menu -pkadmin sound : Turns on/off sound alerts + pkadmin alert : Turns on/off channel alerts -pkadmin volume <0-100> : Sets the play volume for sound + pkadmin sound : 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.