WoW Roster 1.6.0-Nuke Installation Documentation

Back to Documentation Index

Table of Contents


System Requirements

(Back to Table of Contents)

Optional recommended components


Currently Known Issues

(Back to Table of Contents)

Change Log

(Back to Table of Contents)

MySQL Setup

(Back to Table of Contents)

A full discussion of installing and configuring MySQL, phpMyAdmin, and other related tools is beyond the scope of this document. We'll assume that whoever runs your MySQL server has already created an account that your roster installation can use, and that they've already installed phpMyAdmin.

Log into phpMyAdmin with the username and password that the roster will use. In our examples, the username is roster160, the user's password has already been set, and the WoW roster tables will be stored in a database named roster160.

Login screen for phpMyAdmin
Login screen for phpMyAdmin

New Installations

If this is your first installation of WoW Roster, your roster database will be completely empty, as shown in the figure below.

phpMyAdmin window with empty database
phpMyAdmin window with empty database

Click the SQL tab in the right-hand pane of the phpMyAdmin page. At the bottom of the SQL tab, you'll see an option to upload a file containing SQL commands. The file roster160.sql included in the WoW Roster distribution will create an empty set of tables for the roster information. Click the Browse button and locate your copy of the roster160.sql file. Then click the Go button at the bottom of the pane to upload the SQL commands.

Ready to upload database schema
Ready to upload database schema

Assuming everything works, you should get a response from phpMyAdmin similar to the one below. In particular, you're looking for a message of "Your SQL query has been executed successfully".

Database schema uploaded successfully
Database schema uploaded successfully

Upgrade Installations

Due to the significant number of changes made to all files, the conf.php, and the database structure...

- THERE IS NO UPGRADE TO 1.6.0! Fresh install is manadatory

 

- To Move your Roster 1.6 to Roster 1.6 Nuke . simply add one table 'roster_regmembers'. It can be found at the end of the roster160.sql file


PHP and HTML Setup

(Back to Table of Contents)

This covers the BARE minimum settings that need to be edited in conf.php

Copy/rename the file conf.php.bak to conf.php.

Edit it with Notepad or some other text editor and make the following changes to suit your guild and site setup.

If a variable in conf.php is in double-quotes, it's because the developers expect that the variable contents might contain an apostrophe. For example, there's a $server_name variable, and your guild might play on the Eldre'Thalas server, so the $server_name variable is in double-quotes. Other variables that aren't supposed to ever have apostrophes in them (like $guild_name, $faction, etc.) are listed in single-quotes for performance reasons. Please don't switch around the quoting conventions used in conf.php -- if you run into a problem, post in the general support forum at WoWRoster.net.

conf.php, MySQL Config Section

  1. Change the variable $db_user to the MySQL username that has control over the roster tables. In our examples, that username is roster160.
  2. Change the variable $db_passwd to the password for the MySQL username given above.
  3. Change the variable $db_name to the database that the WoW roster will use. In our examples, that database is named roster160.
  4. Change the variable $db_host to the hostname of your MySQL server. Use localhost if MySQL is running on the web server itself. Many web hosting companies will have MySQL running on servers other than the web servers, and you might have seen that server's name in the title bar of the phpMyAdmin windows. Contact whoever's running your web host if you don't know the answer to this.
  5. Change $db_prefix only when and if you have change the prefix in the database. The default prefix is roster_
  6. Change $nuke_prefix only when and if you have change the prefix in the database. The default prefix is nuke_

conf.php, Roster Config Section

  1. Change the variable $roster_upd_pw with a password of your choosing. You will need this to update the guild list.
  2. Change the variable $roster_lang to the desired language for the roster pages. Current languages supported are limited to English ('enUS') and German ('deDE').

conf.php, Site Config Section

  1. Change the variable $website_address to your guild's normal home page, whether that's a set of forums, a portal site, or whatever. This variable exists solely to give people reading your roster a link back to the main guild site.
  2. Change the variable $roster_dir to the Directory that your roster will be stored in, something like 'modules/'.$module_name;. or if nuke is not in the root web directory 'site1/modules/'.$module_name;
  3. Change the variable $roster_moddir if nuke is not in the root web directory to something like 'site1/modules.php?name='.$module_name;

conf.php, Guild Config Section

  1. Change the variable $guild_name to your guild's name, exactly as it is stored in the game.
  2. Change the variable $server_name to your guild's server. Server names that contain apostrophe characters shouldn't be a problem here, but do make sure that you keep the server name in the double-quotes.
  3. Change the variable $guild_desc to a short description of your guild.
  4. Change the variable $faction to the faction of your guild. Use 'A' for Alliance guilds, and 'H' for Horde guilds.
  5. Change the variable $server_type to the general type of server your guild is on. The current choices are PvE, PvP, RP, or RPPvP.
  6. Change the variable $timezone to your server's timezone
  7. Change the variable $localtimeoffset to your local time zone's offset from UTC. See the Wikipedia entry for time zones to find yours. In the U.S., Pacific Standard Time is -8, Mountain Standard Time is -7, Central Standard Time is -6, and Eastern Standard Time is -5. If your area is currently observing daylight saving time, you'll need to add 1 to the above numbers (so PDT is -7, MDT is -6, etc.).

Upload the Roster Files

Upload all the roster files to your web host by whatever means you normally do (FTP, mapped network drive, etc.) -- if you go to the main roster page (the address you entered for $roster_dir in conf.php), you should see something similar to the following page (if you're reading this documentation off your roster site, try this link):

Roster site before uploading data
Roster site before uploading data

Uploading the First Roster

(Back to Table of Contents)

Get the Profiler Addons

All your guild members who want to publish their character information should download and install the CharacterProfiler addon. At least one guild member needs to download both the GuildProfiler and CharacterProfiler addons and regularly update the list of guild members on the front page of your roster. Even if all your other members use CharacterProfiler regularly, the roster page that lists all your members, their levels, notes, ranks, etc. only gets updated when someone with GuildProfiler updates the roster.

If you (or some of your guild members) never installed WoW Addons before, see this page at WoWInterface.com on how to install them.

Run the Profiler Addons

Log into WoW. Scroll back up through your main chat window and you should see a message of rpgo-CharacterProfiler [v1.5] loaded, and you should see a message of rpgo-GuildProfiler [v1.5] loaded if you installed GuildProfiler.

If you installed GuildProfiler, click the Guild tab in your Social window. There should be a Save button at the top of it. Click the Save button, and you should see messages like

Guild: YOURGUILD
Guild created M-D-YYYY, X players, Y accounts
That is the indication that GuildProfiler saved your list of guild members.

If you installed CharacterProfiler (you have installed that, right?), open up the following windows before you log out of WoW:

To see what information CharacterProfiler has been able to pick up about your character, type /cp show in your main chat window at any time. Any red-colored warnings indicate areas that CharacterProfiler hasn't yet gathered information on. You can click the Save button at the top of your character information window, or simply log out and CharacterProfiler will save all its scanned information for later upload.

Upload Character and Guild Data (Users with CharacterProfiler and GuildProfiler)

Go to the update page in your roster. If your roster URL is http://www.yourguildname.com/modules.php?name=roster, the update page will be http://www.yourguildname.com/modules.php?name=roster&op=updateProfile (if you're reading this document off your roster website, try this link).

Ready for first upload of guild member list
Ready for first upload of guild member list

Click the Browse button and find your CharacterProfiler.lua file that contains the information that GuildProfiler stored earlier.
If you installed WoW in C:\Program Files\World of Warcraft, the CharacterProfiler.lua file will be in a folder named
C:\Program Files\World of Warcraft\WTF\Account\YOURACCOUNTNAME\SavedVariables\, where YOURACCOUNTNAME should be replaced with the username for your WoW account.
Select this file and click the Open button to mark it for upload.

Locate the CharacterProfiler.lua file
Locate the CharacterProfiler.lua file

Then, back on the updates page, fill in the password box Roster Update Password from what you set $roster_upd_pw in conf.php
Then click the Upload button to actually send the guild information to the roster's web server. This should result in a page similar to the one shown below.

Member list successfully uploaded
Member list successfully uploaded

Now go back to the main page for your roster, and you should see a page similar to the one below, showing statistics on your membership, their names, ranks, levels, etc.

New Roster Front Page
New roster front page


Upload Character Data (Users with CharacterProfiler only)

Go to the update page in your roster. If your roster URL is http://www.yourguildname.com/modules.php?name=roster, the update page will be http://www.yourguildname.com/modules.php?name=roster&op=updateProfile (if you're reading this document off your roster website, try this link).

Ready for upload of character data
Ready for upload of character data

Click the first Browse button and locate the file CharacterProfiler.lua.
If you installed WoW in C:\Program Files\World of Warcraft, the CharacterProfiler.lua file will be in a folder named
C:\Program Files\World of Warcraft\WTF\Account\YOURACCOUNTNAME\SavedVariables\, where YOURACCOUNTNAME should be replaced with the username for your WoW account.
Select this file and click the Open button to mark it for upload.

Locate the CharacterProfiler.lua file
Locate the CharacterProfiler.lua file

Then, back on the update page, click the Upload button to actually send the character information to the roster's web server. This should result in a page similar to the one shown below.

Character information successfully uploaded
Character information successfully uploaded

Some characters will uploaded without any errors or warnings at all. These would be characters on your guild's server that are in the guild and also have quest and tradeskill information.

Characters that have no quests (such as level 1 "mules") may cause warnings such as
Warning: array_keys(): The first argument should be an array in /var/wwwroot/roster160/html/lib/wowdb.php on line 263

Characters on the same account, but on other servers will generate errors of
Could not find guild in database. Please update members first.

Characters on your guild's server, but not in the guild, will generate errors like
Doug is not in the list of guild members so their data will not be inserted.


Testing Other Roster Features

(Back to Table of Contents)

Guild Bank

The guild bank page, where all the inventory and bank items for designated "mule" characters can be collected for display. How your guild designates mule characters can vary. For example, you might assign all mule characters a rank of "Mule" or "Banker". They might all have a particular tag in their note, or in their name. For the purposes of this document, we'll assume that your guild assigns all the mule characters a rank of "Banker Mule".

To enable the guild bank features, edit conf.php according to these instructions:

  1. Make sure that the variable $show_guildbank is set to 1.
  2. Make sure that the variable $banker_rankname is a tag that you want to match from the database (Example Banker)
  3. Make sure that the variable $banker_fieldname is set to the database field that you want to match $banker_rankname to (Example guild_title)

After doing these three steps, any characters with a guild_title of Banker who upload their profiles will automatically have their inventories added to the guild bank page.
If your guild's main roster page is http://www.yourguildname.com/modules.php&name=roster, then the link to the guild bank is http://www.yourguildname.com/modules.php?name=roster&op=guildbank (if you're reading this document off your roster website, try this link).

Guild bank page
Guild bank page

An alternative bank display page, similar to a character inventory, is available if you set the variable guildbank_ver to '2'. Leave it with the default value of '' for the default list-style view (if you're reading this document off your roster website, try this link).

Guild bank 2 page
Guild bank 2 page