GateKeeper Pro 1.0.0 README
-------------------

GateKeeper is a palace server plugin that allows only blessed users to
gain wiz/god
privileges with a certain password, adding a new level "owner",
only owners can use gatekeeper commands.

Installation
------------

The following installation instructions assume that the Palace server
has been installed in /usr/local/palace.

GateKeeper is a standard Palace server plugin. It is installed by
placing the plugin gatekeeper.so, in the Palace binary folder,
/usr/local/palace/bin, and adding the following line to the plugin
configuration file: /usr/local/palace/<palace-name>/psdata/plugin.conf

bin/gatekeeper/gatekeeper.so psdata/gatekeeper.list

The gatekeeper list file is created in /usr/local/palace/<palace-name>/psdata.
Note that gatekeeper reads and writes to this file. Therefore, it cannot be edited.

God Commands:
-------------

gatekeeper adds the following owner commands to the Palace server.

'gatekeeper bless [password] [wiz/god/owner] <[reghash] [name]>/[whisper] - bless a user.
'gatekeeper list - list all blessed users.
'gatekeeper unbless [reghash/whisper] - unbless a user.
'gatekeeper change -p [new password] [reghash/whisper] - change a users password.
'gatekeeper change -n [new name] [whisper] - change a users name.
'gatekeeper change -h [new reghash] [old reghash] - change a users reghash.
'gatekeeper change -r [new rank] [reghash/whisper] - change a users rank.

the ranks are:
wizard - normal wizard privileges.
god - normal owner privileges.
owner - normal owner and gatekeeper privileges.

Gatekeeper Pro
--------------------------------------------------------------
Version: 1.0.3

 
Introduction
--------------------------------------------------------------
Gatekeeper Pro is a updated version of the Gatekeeper plugin. This plugin lets the owner create an approved list of 
users who are allowed to become wizards and gods on your palace. The point of this list is so that not just any user 
can overhear the password and login, instead they have to be pre-approved on this list. The list is known as a bless 
list, and the act of adding someone to the list is called blessing.
 
Unlike the normal Gatekeeper however, Gatekeeper Pro allows each blessed user to choose their own password. This 
increases security and also helps your staff remember their passwords. Gatekeeper Pro also has an added rank, owner,
which seperates palace owners from normal gods by giving them more power. Only users blessed as the owner rank can 
execute Gatekeeper commands. Below is a list of the ranks and their privileges:
 
Wiz     Normal wizard privileges
God     Normal god privileges, can't control owners.
Owner   Normal god privileges and also gatekeeper privileges.
 
 
Usage
--------------------------------------------------------------
After you enable the plugin, you must first bless someone before it fully goes into effect. The first person you bless
will be the only person who can bless from that point forward, therefore we recommend you bless yourself first.
 
How to bless yourself.
1. Connect to your palace and login with the owner password thats indicated on your panel.
2. Bring up the user list by going to Options at the top, then click Find User.
3. Click on your username. It will state you are whispering to yourself.
4. Now issue the whispered `gatekeeper bless command. Details of this command are below.
 
Command Key: The columns 1 through 3 indicate command parameters. The command and it's parameters must all be seperated
by a space. The Whisper column indicates rather the command should be whispered to the user or not.
 
rank      refers to either wiz, god, or owner.
pw        refers to the desired password the user wants.
hash      refers to the user's registration hash code.
 
Command                  1       2       3    Whisper   Description
`gatekeeper list                                 -      Lists all currently blessed users
`gatekeeper bless        pw     rank    hash     -      Bless user by hash with pw as rank
`gatekeeper bless        pw     rank    name     -      Bless user by name with pw as rank
`gatekeeper bless        pw     rank          Whisper   Bless whispered user with pw as rank
`gatekeeper unbless                              -      Unbless user by hash
`gatekeeper unbless                           Whisper   Unbless whispered user
`gatekeeper change -p    pw     hash             -      Changes pw of the user by hash
`gatekeeper change -p    pw                   Whisper   Changes pw of the whispered user
`gatekeeper change -n    name                 Whisper   Changes name of the whispered user
`gatekeeper change -h    hash2  hash1            -      Changes user with hash1 to hash2
`gatekeeper change -r    rank   hash             -      Changes user by hash to rank
`gatekeeper change -r    rank                 Whisper   Changes whispered user to rank
 
Example: Let's say there was someone I wanted to hire as a god on my palace. I ask them what password they would like
to use when logging in, and they reply with "zeebot2". I then whisper this command to them: 
    `gatekeeper bless zeebot2 god. 
It should bless them and they can now login with the password zeebot2.
 
 
Advantages
--------------------------------------------------------------
   1. Only allows users who have been pre-approved to become a wizard or god.
   2. Allows for blessed users to choose their own unique password.
   3. Includes a 3rd rank, owner, which allows a distinction between owners and gods.
 
Disadvantages
--------------------------------------------------------------
   1. No option to autologin.
   2. Cannot bless a user by their IP address.
   3. Cannot create custom ranks.
   4. Cannot edit rank privileges.
 
Bugs
--------------------------------------------------------------
No reported bugs at this time.