Configuration
The plugin's global configuration file is a standard YAML file located:
plugins/Inquisitor/config.yml
It is recommended you don't edit this file directly. The plugin provides commands to alter all the settings in the file either in-game or from the console. If you do decide to edit the file by hand, you should not edit while the server is running since your changes could be overwritten when the server is stopped or the configuration is explicitly saved.
The configuration file is in multiple sections. Each section corresponds to a group of commands. See the Commands page for the commands to change these options.
If an option is not present in the configuration file, the indicated default is assumed.
Global
These options exist in the "global" section and can be configured with the inq set ... command, unless otherwise noted.
Option | Type | Default | Version | Description |
debug | boolean | false | All | Specifies whether or not debugging is turned on. With debugging on, extra messages are displayed on the console. A lot of them. This can effect the performance of the MC server, so you shouldn't leave this on normally. |
Database
These options exist in the "db" section and can be configured with the inq db set ... command, unless otherwise noted.
Option | Type | Default | Version | Description |
debug | boolean | false | v2.0 | When set, displays all SQL queries being executed against the database. All queries use prepared statements for safety and speed. Because of this query parameters aren't displayed, so you won't see specifics in the queries. |
url | string | none | All | The JDBC URL for the database. This URL will look something like jdbc:mysql://localhost/dbname . Substitute a different hostname and database name as necessary. If your MySQL server is using a non-default port, put a colon and the port number after the hostname (e.g., jdbc:mysql://localhost:4567/dbname). |
username | string | none | All | The username to use when connecting to the database. This user must have CREATE, ALTER, DROP, INDEX, INSERT, UPDATE, DELETE, and SELECT privileges for the database. |
password | string | none | All | The password to use when connecting to the database. The password is stored in the config file in clear text but is displayed as "******* " at the console or in-game. |
prefix | string | none | All | The table name prefix. If the plugin is configured to use a database that is being used by other plugins or applications, you might need to set this prefix to avoid table name conflicts. |
shared | boolean | true | All | Is the database shared by other copies of this plugin on other Bukkit servers. This option should generally not be changed, even if the plugin is only running on a single server. This option effects how the plugin detects player's beds. It's complicated. |
Statistics Engine
These options exist in the "stats" section and can be configured with the inq stats set ... command, unless otherwise noted.
Option | Type | Default | Version | Description |
debug | boolean | false | v2.0 | If set, messages will be displayed about various details of the engine. |
flushCheckInterval | integer | 10000 | v2.0 | The interval, in milliseconds, between checks for cached statistic group instances that need to be flushed. |
Saving Statistics
v2.0 of the plugin introduces a new statistics engine. The new engine differs from the old engine in 2 important ways: it's been generalized to be able to handle dynamic statistics for any purpose, and database updates happen in a background thread. The first feature will be more utilized in future plugin versions. The second feature means the main server thread is generally never blocked by database updates. It can still be blocked under specific cases, like when a player quits, since those updates need to be synchronous to make sure other things don't get out of whack.
Player Statistics
These options exist in the "players" section and can be configured with the inq players set ... command, unless otherwise noted.
Option | Type | Default | Version | Description |
debug | boolean | false | v2.0 | If set, message will be displayed about various player statistic details. |
flushInterval | integer | 60000 | v2.0 | The interval, in milliseconds, between flushing (saving to the database) cached player statistics. |
bedCheckInterval | integer | 20000 | All | The interval, in milliseconds, between performing checks on players' beds to see if they still exist. |
deleteAge | integer | -1 | v2.2 | The age, in milliseconds, after which player statistics will be deleted from the database. This is in milliseconds, so be very careful! A value of -1 disables this feature. |
invalidPlayerNamePattern | string | none | v2.18 | A regular expression that matches player's name that SHOULDN'T have stats collected. This is useful if your server has plugins that create "fake" players for various reasons and those players shouldn't be stored in the database. The names of those players usually follow a pattern that can be matched by a regular expression. For example, the exclude all player names that start with "pvp" or "kill", use the pattern "^(pvp|kill).*$" . |
Web Server
These options exist in the "webserver" section and can be configured with the inq webserver set ... command, unless otherwise noted. In addition, the inq webserver add ... and inq webserver remove ... commands can be used with the playersColumns and playersRestrictColumns options.
Option | Type | Default | Version | Description |
address | string | none | v2.11 | The IP address to bind to. If not set, all local interfaces are bound to. Specify '*' or '-' to reset to an empty value. |
playersColumns | string | too long | v2.0 | A comma delimited list of fields to show in the players list page. List the non-JSON fields from the Player Statistics page you'd like to display by default, in the order you want them displayed. The "name" column is automatically included. To reset to the default, set the value to "*". |
playersSortColumn | string | name | v2.0 | The default field name by which to sort the players list. |
playersSortDir | string | ASC | v2.0 | The default sort direction for the players list. Valid values are "ASC" and "DESC" for ascending and descending, respectively. |
playersRestrictColumns | string | too long | v2.0 | A comma delimited list of fields that cannot be displayed in the players list by users using the column selection dialog. To reset to the default, set the value to "*". |
playersPageSize | integer | 50 | v2.0 | The default number of players on each page of the players list. If more than this many players match the search criteria, the players list will automatically paginate and show a maximum of this many players on each page. |
port | integer | 8080 | All | The port to listen on for incoming connections. |
upgradeWebRoot | boolean | true | v2.0 | When set, the plugin will overwrite existing web resources, even if they've been changed. Leave this set to true to automatically update the web pages displayed by the plugin. If you've made customizations to the templates, set this option to false so they don't get overwritten. |
workers | integer | 5 | All | The number of worker threads available to handle incoming requests. |
Looks great and I like where you're going. I'm having what should be a simple issue:
Cannot connect to mysql because I'm not certain how the port should be configured within the url string. Instructions in configuration not crystal clear on this.
Strings I've tried: jbdc:mysql://localhost/oasisoils_mysql:3306 jbdc:mysql://localhost:3306/oasisoils_mysql
Wow this is great. Any way to import statistics from BeardStats? I'd love to switch to this, but I could not afford losing my server stats.
Just one comment so far<sub> this thing is a nightmare to config. </sub>
Can we please have a default config created upon first launch.. Having to type all this in console is maddening,
I mean leave both, for the people that don't have direct files access, or can't figure out your way of writing and and then modifying your config, well they can use commands,
but i need something i can open up and edit in 2 mins and reload, i am sure others would like this as well,
@SmAsHXT
Agree, a default config file would be awesome instead of typing in each thing
Agreed, this plugin is great, but configuration of its is a complete mess.
Would a simple yml file do for all these options instead of using all command lines driven configs?
@dockter
first 2 lines "The plugin's global configuration file is a standard YAML file located:
plugins/Inquisitor/config.yml"
I think thats your config
My config.yml isn't filled....o.O
Yeah if this had a default config file I would use it, hope to see it come soon, if someone has this fully configured, could you upload your config without your sql details obviously, much appreciated.
{global: null}
dosn't help me :D
please help me to configure the Plugin :D
It's actually pretty easy - if you've got mysql on your server, just follow the steps on the getting started page (http://dev.bukkit.org/server-mods/inquisitor/pages/getting-started/) and it'll be up and running. You only need a few commands to set the basic options needed for the plugin to run
love this plugin :D I am using it a lot now and i want to expand it :)
But i have some questions
With total time will it only safe played time or also AFK time ?
@phuriousgeorge
its a mix of both :P;
jdbc:mysql://localhost:3306/oasisoils_mysql
my config file isn't filled :(
@frdfsnlght It says it is not connected to database. is there a command to connect or is it not connecting properly?
This plugin is epic. The web server setup that comes with it looks great too, only problem is I can't get it to forward properly to the web. I'm gonna have to take a good look at it, but I can't figure out a mod_proxy implementation, and simply forwarding the port isn't working for me now. Maybe I broke some stuff editing files. It would really be awesome/ideal if there was a standalone web folder to drop into an existing webserver that would query the database with similar looking pages. Then I'd give it three thumbs up.
In any case for the users below, here is a sample config that might help you, though you should set your config by using commands per plugin author's instructions. Copy and paste it cause looks like the line breaks might be messed up, then edit username, password, and database name for your specific installation.
@cars26
Same here, my config file isn't filled either.
For some reason, I am running 1.5 bukkit, the plugins is not working. Not even starting up and creating a folder.
i set this up on my test server b4 i put it on my main server got the db working webserver working on local host but say no players ect i look into logs and get this on every join http://pastebin.com/BXEYieMF
if its permmision based i am op
thanks
@77tontos
You connect it through commands ingame...