EQDKP plugin

From DKPLP Doc

The EQDKP plugin allows the program to communicate with EQDKP. The EQDKP plugins implements specification S7 of the server interface and is backwards compatible with all of the earlier specifications.

Contents 1 Installation 2 Contents 3 Constants 3.1 DKPLP_NEW_MEMBER_RANK 3.2 DKPLP_SPECIFICATION_NUMBER 3.3 DKPLP_CONFIG_FILE 3.4 DKPLP_COMPLETIONS_FILE 3.5 DKPLP_MEMBER_ALIASES_FILE

Installation

The plugin is contained in it's own package and has to be downloaded separatly. The plugin itself is located in a directory named plugins which should be included in the download.

1. Upload the folder which contains the plugin you want to install into EQDKP's plugin directory. The plugin directory is the directory named plugins in the EQDKP root directory.
2. Log in as administrator and access the administration panel. There should be an link named Manage Plugins to the left, click it.
3. You should now have a list of plugins, including DKP Log Parser. There should also be a link named Install in the same row, click this to install the plugin.
4. Some information about the installation should be displayed and hopefully that the installation was successful.

You might also want to make sure that the server has permission to write to the directory named "storage" and all the files within, it is needed if you later on want to upload configurations and other information.

The plugin has been tested with EQDKP version 1.2.0 and 1.3.0, and should work with most other versions too.

Contents

The plugins doesn't contain any user-viewable pages, but it might be interesting to know what each file included is.

• plugins: Directory
  • dkplp: Directory
    • dkplp_plugin_class.php: The plugin definition page.
    • readme.txt: A short version of this readme.
    • dkprpc.php: The XML-RPC interface for EQDKP. This is the interface that should be ported if one wants to have DKP Log Parser talk with another type of DKP databse system.
    • util.php: A file containing utility classes and functions.
    • deprecated.php: A file containing deprecated functions that gives the interface backwards-compatibility.
    • xmlrpc: Directory
      • dkprpc.php: An old version of the interface for backward compatibility.
    • lib: Directory
      • xmlrpc.php: A standalone XML-RPC library. It is used because not all servers have XML-RPC support installed. See http://phpxmlrpc.sourceforge.net/ for more information.
      • xmlrpcs.php: The second part of the standalone library.
    • storage: Directory
      • conf.xml: An empty placeholder for the uploaded configuration file.
      • autoCompletions.xml: An empty placeholder for the uploaded completions.
      • memberAliases.xml: An empty placeholder for the uploaded member aliases.

Constants

There are a couple of constants in the dkprpc.php file. They can be altered to change the plugin's behaviour.

DKPLP_NEW_MEMBER_RANK

The unique identifier for the rank that members added through DKP Log Parser clients should have, e.g. 0, 1, 2, 4, 8 and so on. The default value is 1 which is usually the rank held by members. Look into EQDKP's member_ranks database table for the list of the ids and names, it's the id that should be used.

DKPLP_SPECIFICATION_NUMBER

The plugin's specification number string, altering this may cause unexpected behaviour as the client might think the plugin support things that it actually doesn't. So don't alter this unless you know what you're doing.

DKPLP_CONFIG_FILE

The location where the file that contains the stored client configuration should be stored. The configuration is then given out to clients on request.

DKPLP_COMPLETIONS_FILE

The location where the file that contains the stored client auto completions should be stored. The completions are then given out to clients on request.

DKPLP_MEMBER_ALIASES_FILE

The location where the file that contains the stored member aliases should be stored. The member aliases are then given out to clients on request.