Pages

Documentation

It is helpful for the person configuring CommunityBridge to have a basic understanding of MySQL and how the web-application stores user, group, and custom profile field data.

Installing

  1. Make a backup of your Minecraft server and your website, in particular, the web application's MySQL database. Also, it is highly recommended you work out the details of the configuration on a test copy of the game and website, if possible.
  2. Put the CommunityBridge.jar in the Minecraft plugins folder.
  3. Restart your Minecraft server or if you prefer, use /reload.
  4. A CommunityBridge folder should appear in your plugins folder which contains the config.yml and messages.yml files.
  5. Edit the config.yml file to configure CommunityBridge (see Configuration below).
  6. Edit the messages.yml file to suit your tastes or your language.

Commands & Permissions

CommandPermissionDefaultDescription
cbsynccommunitybridge.cbsynctrueSchedules a group & statistics synchronization for a player.
cbsyncallcommunitybridge.cbsyncallopSchedules a group & statistics synchronization for all connected players.
cbreload [filename]communitybridge.cbreloadopLoads config.yml or the specified file configuration from disk.

Configuration

Read through the entire default config.yml before configuring CommunityBridge. Some of the settings and explanations might not make sense the first time through, but it'll help you to have some of it in mind as you go through the configuration process. Here is a link to a copy of the default config.yml: Default/Blank config.yml

CommunityBridge is composed of a few major features: player-user linking, group synchronization, requirements, statistics synchronization. I strongly recommend that you configure and test only one of these features at a time. Since all other features depend on the database and player-user linking sections being configured correctly, do those sections first. So a typical configuration session might go like this:

  1. Confirm that your web application's MySQL database will allow a connection for your database user from the Minecraft Server's IP address.
  2. Collect up key information about your MySQL database: hostname, database username, database password, database name, users table, user_id column, etc.
  3. Set the log-level in the config.yml file to 'config'.
  4. Configure the database section.
  5. Configure the player linking section.
  6. Use cbreload. Check for any errors and make any necessary corrections to the configuration.
  7. Configure another major feature you wish to use.
  8. Use cbreload. Check for any errors and make any necessary corrections to the configuration.
  9. ... repeat as necessary.
  10. Set the log-level to 'info'.
  11. Finally, completely restart the server to clear out any leakage that occurred during cbreload (or reload if it was necessary).

Sample Configurations

DO NOT use these files as is. They are intended for you to use as a GUIDE to how to configure CommunityBridge to fit your forum and needs.

Detailed Information For Each Configuration Section

The following are links to pages that cover each major section of the configuration in detail. At least, they will as soon as they're written. :). Throughout, they will refer to the " Default/Blank config.yml" file.

Comments

Posts Quoted:
Reply
Clear All Quotes