Configuration

jomo edited this page May 3, 2014 · 6 revisions

Main Config

loggedWorlds:
- world
- nether

Names of the worlds you wish to have logged. Ensure you use the exact name as specified in server.properties, including path.

version: '1.40'

This doesn't mean anything to the end-user (but don't delete it!). It is simply the version the config was created under and won't always update when there is a LogBlock update. Don't worry if it's not the same value as the version of LogBlock you're running.

MySQL

host: localhost

Address or the MySQL server. Can also be an IP, in case you are using a remote SQL server.

port: 3306

Port of the MySQL server.

user: username

The MySQL username. Try to avoid using root.

password: pass

Password for the MySQL user.

database: minecraft

The database that LogBlock should use. It must be an existing database as LogBlock isn't able to create one.

Consumer

useBukkitScheduler: true

Toggles whether to use the Bukkit scheduler or a Java timer. In most cases it's perfectly okay to use the Bukkit scheduler, but when queue only gets processed at server shutdown, you should set this to false.

delayBetweenRuns: 6

Seconds between consumer runs.

timePerRun: 100
forceToProcessAtLeast: 25

The consumer will run until the queue is empty or timePerRun is exeeded. The default options will work in most cases, but should only be changed when the queue increases and begins to spam warnings. forceToProcessAtLeast is there to force the consumer to work, even if there is high cpu load. On a system with high cpu load, the consumer may only process 10 blocks per run, ultimately leading to an overloaded queue, thus, increasing forceToProcess would be a solution.

Clearlog

enableAutoClearLog: false
auto:
- world "world" before 365 days all
- world "world" player lavaflow waterflow leavesdecay before 7 days all
- world world_nether before 365 days all
- world world_nether player lavaflow ghast before 7 days all
- world "world" player Notch all

All listed lines will be used as params for auto clearlog commands. You can use all commands that work in console. You always have to specify the world. Remember all means block place, break and chest access. More info about parameters can be found on the params page.

dumpDeletedLog: true

Toggles whether to dump to a log file before deleting. The dump files are stored in /plugins/LogBlock/dump/. This doesn't work for a remote MySQL server. Disable if you get MySQL errors prefixed with [LogBlock ClearLog].

Logging

logCreeperExplosionsAsPlayerWhoTriggeredThese: false

Logs creeper explosions under the name of the player who triggered the exploosion. If this is set to true, you must use /lb [...] player <playername> instead of /lb [...] player Creeper.

logKillsLevel: PLAYERS

There are three log levels:

1) PLAYERS - Only players who killed another player

2) MONSTERS - Players and monsters

3) ANIMALS - Logs every kill

logEnvironmentalKills

Set this to true to log kills not directly caused by other entities. Examples include burning to death, falling, and suffocation.

hiddenPlayers: []

The players listed there won't get logged. Not recommended to use!

hiddenBlocks:
- 0

These blocks are ignored for logging. Not recommended, except you don't use rollbacks. Air (0) must be there.

logPlayerInfo: false

Set to true to log player online time, time of first and last login, and IP address of last login.

Rollback

replaceAnyway:
- 8 //Water
- 9 //Water
- 10 //Lava
- 11 //Lava
- 51 //Fire

By default, these are blocks that are considered to spread naturally. These are blocks that will be replaced at rollback.

dontRollback:
- 10 //Lava
- 11 //Lava
- 46 //TNT
- 51 //Fire

By default, these are blocks that are considered harmful and shouldn't be spawned again. Upon rollback, if they were destroyed, they won't be placed back in the world.

Lookup

defaultDist: 20
defaultTime: 30 minutes

Default values for parameters area and time.

toolblockID: 7 //Bedrock
toolID: 270 //Wood pickaxe

ID's for items to be given to player when tools are summoned. Ensure toolblockID is the ID of a block and toolID is the ID of an item.

toolQuery: area 0 all sum none limit 15 desc
toolBlockQuery: area 0 all sum none limit 15 desc

Queries to be performed upon use of tool. For information on forming these, see the params page.

Safety

id.check

Set this to false to log all blocks, even those with id numbers beyond those normally used by minecraft e.g. mods.

Questioner

askRedos: true
askClearLogs: true
askRollbacks: true
askClearLogAfterRollback: true

Toggles whether LogBlock will ask Are you sure? before doing something. REQUIRES LOGBLOCK QUESTIONER TO BE INSTALLED!

World Config

table: lb-main

The table this world is logged into.

logging

BLOCKPLACE: true
BLOCKBREAK: true

Should be self-explanatory, includes bucket usage and blocks washed away.

FIRE: false

Logs burned blocks. Not as the player who started the fire, but as Fire.

TNTEXPLOSION: false
MISCEXPLOSION: false
CREEPEREXPLOSION: false
GHASTFIREBALLEXPLOSION: false

Logs exploded blocks, Logged as TNT, Creeper and Ghast.

LEAVESDECAY: false

Logs decayed leaves as LeavesDecay. Warning: Will cause rapid expansion of database.

SIGNTEXT: false

Logs the text of placed signs as additional info.

CHESTACCESS: false

Logs what someone took from, or put into a chest, dispenser or furnace. Contrary to popular belief, this does not require the infamous Spout plugin.

KILL: false

Logs kills. Only for statistical use, there is currently no way to lookup via commands.

CHAT: false

Logs chat and commands. Only for statistical use, there is currently no way to lookup via commands.

SWITCHINTERACT: true
DOORINTERACT: false

Log pressed buttons, doors and switched levers. Cannot currently be rolled back.

WATERFLOW: false
LAVAFLOW: false

Log water and lava movement as well as cobble and obsidian block creation by liquids. Warning: Will cause rapid expansion of database. Logged as WaterFlow and LavaFlow.

SNOWFORM: false
SNOWFADE: false

Log snow and ice block created by weather or destroyed by heat sources like lava, fire and torches. Logged as SnowForm and SnowFade.

CAKEEAT: false

Log when cake gets eaten.

ENDERMEN: false

Log when an Enderman steals blocks.

BONEMEALSTRUCTUREGROW: false
COMPARATORINTERACT: false
CREATURECROPTRAMPLE: false
CROPTRAMPLE: false
DIODEINTERACT: false
ENDERDRAGON: false
GRASSGROWTH: false
LOCKEDCHESTDECAY: false
MUSHROOMSPREAD: false
MYCELIUMSPREAD: false
NATURALSTRUCTUREGROW: false
NOTEBLOCKINTERACT: false
PRESUREPLATEINTERACT: false
TNTMINECARTEXPLOSION: false
TRIPWIREINTERACT: false
VINEGROWTH: false
WITHER: false
WITHER_SKULL: false
WORLDEDIT: false

(description missing)