Installation

Installation

For a quick installation, download the files and put them in a folder on your webserver. Once in place you create the config.php file by renaming the config.template file and then following the instructions in the new config.php. That's it.

Requirements

• PHP server running PHP 5.0 or greater
• GD Graphics Library (optional but recommended)
• A Database login with permissions to SELECT and UPDATE. It's recommended that you restrict permissions as much as possible. UPDATE permission can also be excluded but you will need to disable the character mover. See the Configuration Section for info on configuring the character mover.
• A MySQL database with the PEQ or a custom database installed. This can be the live database from your live EQEmu server or a clone. A clone would require periodic updates.

Note: Databases other than MySQL are possible but it will require customzation of ./include/db.php

Installation

• Create a navigable folder on your webserver: e.g, MySite.com/CharBrowser/.

• Download the CharBrowser project and place the files in this new directory, e.g, MySite.com/CharBrowser/index.php.

• Rename the ./include/config.template file to ./include/config.php. This is the file that permits you to tell CharBrowser how to connect to your database. It starts with a .template extension so when you paste a new build over your previous install it won’t overwrite your .php copy. That said you should always review the new .template copy for new settings and changes.

• Edit ./include/config.php. and find this section:

Note: Older versions may not have the cb_ prefix.

$cb_db     =   "peq";
$cb_host   =   "localhost";
$cb_user   =   "";
$cb_pass   =   "";

Now modify it with your database name, host, username and password, respectively. It should look something like this:

$cb_db     =   "peq_database";
$cb_host   =   "localhost";
$cb_user   =   "Maudigan";
$cb_pass   =   "$uper$ecretPassw0rd";

• Your users should now be able to navigate to MySite.com/CharBrowser/index.php and start using the tool.

Optional Installation Steps (recommended)

• Review the extended configuration options covered in the Configuration Section. This isn’t required, but ultimately you should review these settings to check for any player privacy concerns and to ensure the Character Mover is setup correctly for your server.

• Create a quest NPC to allow users to show/hide their character profile. By default users can show/hide their profile with role playing and anonymous, but there is a more user friendly quest system. This is detailed in the User Permissions Section.

Optionaly Embedd Into Your Site

You can embed CharBrowser into forums or whatever your site happens to be. This is still in development. More information here.

Updating

Updating the tool is typically a single step that’s easily automated. You just do a git to the target directory, or paste the new files over the old files. The config file from GitHub will have a .template extension so it won't overwrite your customized config.php.

Care should be take as occasionally options in the config file will change, so ideally you would recreate the file each time from the template. I try to keep that in mind and not make modifications that will mess things up if you skip that step.

You should always test each page after an update to ensure functionality hasn’t been effected.