-
Notifications
You must be signed in to change notification settings - Fork 20
Configuration
waweber edited this page Apr 26, 2011
·
9 revisions
NOTE: BigBrother recently switched from using BigBrother.properties to using BigBrother.yml. PLEASE MAKE SURE YOUR SETTINGS HAVE BEEN TRANSFERRED CORRECTLY!
BigBrother uses the widely-used and familiar YAML format for its configuration files, as it is structured and orderly. BigBrother creates the BigBrother.yml file on server startup with some default values. To help you set BigBrother up, here is a short guide.
Note: YAML keys are specified as paths, so database.mysql.port means the following entry in BigBrother.yml:
database:
mysql:
port: 3306
As the most important group of settings in BigBrother, these come first.
| Path | Default | Description |
|---|---|---|
| database.deletes-per-cleansing | 20000 | The maximum number of records to delete per cleansing (0 to disable) |
| database.cleanse-age | 3d | The maximum age of items in the database (can be mixture of #d,h,m,s) (0s to disable) |
| database.max-records | 3000000 | The maximum number of records that you want in your database (-1 to disable) |
| database.send-delay | 4 | Delay in seconds to batch send updates to database (4-5 recommended) |
| database.mysql.prefix | (Currently MySQL-only) Table Prefix to use. For example, bbdata would become bb_bbdata if the value for this was "bb_". |
| Path | Default | Description |
|---|---|---|
| database.type | SQLITE | Either MYSQL, SQLITE, H2 or POSTGRES |
| database.mysql.username | minecraft | The username used to log into the MySQL server. **DO NOT USE root!** |
| database.mysql.password | Password used to log into the MySQL server. | |
| database.mysql.hostname | localhost | The IP or hostname of the MySQL server (localhost = the same machine that BB is on) |
| database.mysql.database | minecraft | The Database (AKA Schema) that BigBrother will use. |
| database.mysql.port | 3306 | The port that MySQL uses. Default should be okay. |
| database.mysql.engine | MyISAM | Depreciated. |
| database.mysql.low-priority-insert | true | Use`LOW PRIORITY` on `INSERT` statements? (Performance thing: waits until all other clients are not reading from the table before the table is updated. If another application will be reading from this table very often, leave this off or logs might not get saved for some time.) |
At the moment, H2 does not contain any options to speak of.
At the moment, PostgreSQL is using the MySQL options. You must set database.type to POSTGRES.
The engine and low-priority-insert options are ignored. The default port for PostgreSQL is 5432.
Tweak what BB logs in this section
| Path | Default | Description |
|---|---|---|
| watched.blocks.block-break | true | Watch when players break blocks |
| watched.blocks.block-place | true | Watch when players place blocks |
| watched.player.teleport | true | Watch when players teleport around |
| watched.blocks.chest-changes | true | Watch when players add/remove items from chests |
| watched.chat.commands | true | Watch for all player commands |
| watched.chat.chat | true | Watch for player chat |
| watched.player.login | true | Watch for player logins |
| watched.player.disconnect | true | Watch for player disconnects |
| watched.misc.door-open | false | Watch for when player opens doors |
| watched.misc.button-press | false | Watch for when player pushes buttons |
| watched.misc.lever-switch | false | Watch for when player switches levers |
| watched.misc.flint-logging | true | Watch for when players start fires |
| watched.environment.leaf-decay | false | Watch for when leaves drop |
| watched.explosions.tnt | true | Watch for when TNT explodes |
| watched.explosions.creeper | true | Watch for when Creepers explodes |
| watched.explosions.misc | true | Watch for miscellaneous explosions |
| watched.player.ip-player | true | Log player IPs. |
| watched.player.drop-item | false | Log item drops |
| watched.player.pickup-item | false | Log item pickups |
| watched.environment.lava-flow | false | Log lava flows |
| Path | Default | Description |
|---|---|---|
| general.excluded-blocks | [] | A list (`[itemID,itemID2...]`) of blocks you do not want to log. |
| general.stick-item | 280 | The item used for /bb stick |
| general.restore-fire | false | Restore fire when rolling back |
| general.auto-watch | true | Automatically start watching players |
| general.default-search-radius | 2 | Default search radius for bbhere and bbfind |
| general.personal-log-files | false | If true, will also log actions to .logs (one for each player) |
| general.rollbacks-per-tick | 2000 | How many rollbacks to execute per tick (BROKEN) |
| general.debug-mode | false | Leave debugging stuff in the server console. |
| general.library-autodownload | true | Automatically download database drivers? |
| general.tnt-threshold | 10.0 | How big TNT explosions are (?) |