Bukkit

Configuration is primarily done through the script itself rather than editing configuration files. However, if you prefer, you may always edit the config files.

NOTE: If the computer you are using is NOT the computer that is hosting the web server, or the Minecraft server, you may need to configure the Failsafe IP list before running setup.php for the first time. This limits who may use the setup script to make changes to your X-Ray Detective installation.

=== Database Configuration === (config_database.php)

These are the settings that X-Ray Detective will use to connect to your MySQL server. Your MySQL server does not have to be located on the same server as your Minecraft server, or your webhost. Your Logging Software plugin MUST store its information in a MySQL server, which you must have already setup as well. Flatfile storage is not supported.

db_module_type

The type of Logging Software plugin that your Minecraft server uses to track and prevent griefers. Options:

• LB - LogBlock
• GD - Guardian (Not Yet Supported)

[Source Database]

host

Source Hostname - The hostname of the MySQL server that contains your Logging Software.

base

Source Database - The database within the MySQL server that contains your Logging Software.

user

Source Username - The username that you will use to connect to this database. For security purposes, we recommend you NOT use 'root'. Create a new user account for your MySQL server that only has permission to create tables, and modify information specifically in the Database you specified above.

password

Source Password - The password for the username above. Do NOT use the same password as your Minecraft login, email, or other sensitive account. You won't be typing this password in anywhere but here, so make it secure. This password is currently stored in plaintext. A more secure method will come in the future.

prefix

Source Prefix - The prefix for the tables that contain your Logging Software. If you don't know what it is, then leave this blank. The prefix is typically used if you are using a single database to store information from multiple Minecraft servers.

[X-Ray Database]

This is the database that X-Ray Detective will create its own tables in, to store the statistics it collects about user mining behavior. NOTE: It must currently be the same as the database above. Support for different databases is coming soon.

host

X-Ray Hostname - The hostname of the MySQL server that will contain your X-Ray Detective tables.

base

X-Ray Database - The database within the MySQL server that will contain your X-Ray Detective tables.

user

X-Ray Username - The username that you will use to connect to this database.

password

X-Ray Password - The password for the username above.

=== Settings Configuration === (config_settings.php)

Any non-database related settings are contained here.

[Authorization]

failsafe_ips

List any IPs that will be given administrator powers in the event that they can't authenticate via USERNAME or PASSWORD mode above.

This prevents you from being locked out of the script if your config gets messed up or you somehow get removed from the admin list.

The IP 127.0.0.1 will always be given administrator access, even if it is not included in this list.

Example: failsafe_ips = 192.168.1.5, 123.4.5.67

NOTE: If the computer you host the Minecraft server on is different from the webhost, you may have to add your IP to the failsafe list to login.

For instance, if I login to my MC Server from the same computer that the MC Server is running on, it will log my IP address into the LogBlock table as '127.0.0.1' (localhost). But when I run the X-Ray script, the remote webhost sees my external IP address (123.45.67.89). It concludes that my IP 123.45.67.89 is not equal to 127.0.0.1, and thinks I am not a valid user.

Note that this problem will NOT occur if you login to your server from a computer outside the LAN of both the webhost and MC server. If you are inside either LAN, then your IP is seen differently by each computer, thus the mismatch.

mode

Select a method of granting access to the X-Ray Detection script.

• username - Users are granted access automatically after logging into your Minecraft server with a username specified in one of the usernames lists below. Do not use this method if your server is a cracked server: online-mode=false in server config.
• password - Anyone may login to the script if they enter the correct password for their user type. Note: Each user does not receieve their own password. There is only one valid password per level.
• none - Everyone is granted User status. No one may make changes at all. Only computers accessing the script from the Failsafe IPs specified above will be given Administrator status.

admin_usernames

Used with [mode = username] above.

A comma separated list of all in-game usernames that specifies which users are automatically given Administrator status after logging into your Minecraft server from the same computer that they access X-Ray Detective from.

mod_usernames

Used with [mode = username] above.

A comma separated list of all in-game usernames that specifies which users are automatically given Moderator status after logging into your Minecraft server from the same computer that they access X-Ray Detective from.

user_usernames

Used with [mode = username] above.

A comma separated list of all in-game usernames that specifies which users are automatically given User status after logging into your Minecraft server from the same computer that they access X-Ray Detective from.

admin_password

A single password that will grant anyone who enters it Administrator status.

Example: admin_password = adminpassword

mod_password

A single password that will grant anyone who enters it Moderator status.

Example: mod_password = modpassword

user_password

A single password that will grant anyone who enters it User status.

Example: user_password = userpassword

[Advanced Settings]

These settings change the way that X-Ray Detective processes users' mining behavior, and how it separates the statistics.

ignorefirstore_before

If the first block broken in a mine in an ore, the stats will not count any ores broken among the first (X) blocks.

Default: 2

mine_max_distance

A block must be within (X) blocks of all previous blocks to be considered part of the same mine.

Default: 5

Recommended 1 to 10, 1 is very strict and will cause more fragmented statistics, 10 will lump more stats together but provide smoother statistics.

postbreak_check

How many broken blocks to check for after the last ore in a cluster is detected. This affects the statistics related to 'mining after discovering ores'.

Default: 3

[Worlds]

You cannot edit which worlds X-Ray detective uses in the configuration file. You must use the Setup page to change these options.