Skip to content

Latest commit

 

History

History
79 lines (68 loc) · 2.41 KB

README.md

File metadata and controls

79 lines (68 loc) · 2.41 KB

TOML logo

EventLogger

Minecraft plugin for inspecting data of events that occur

Note

This project is quickly evolving and I can't keep the README up-to-date with every update, if you'd like to build/use this project, contact me using any of the following methods
Discord - matytyma
HackClub Slack - @matytyma

Installation

Either download a prebuilt JAR from releases or build it from source

Configuration

whitelist - Whether to log just events or the rest instead

events - List of Event class names be logged/excluded from logging

format - Formatting options to style the generated output

Visual representation of formatting options
Block(position=[109, 97, 5871], type=Material.BEDROCK, data=BlockData(data=minecraft:bedrock))
     ^         ^       ^^    ^      ^                ^^                                      ^
     |         |       |     |      |                |                                       |
     |         |       |     |      |                - class.separator         class.postfix -
     |         |       |     |      - field.separator
     |         |       |     - array.postfix
     |         |       - array.separator
     |         - array.prefix
     - class.prefix

Examples

Log all block-related events

whitelist = [ 'BlockEvent' ]

Log all inventory-related events, block-related events and player movement event

whitelist =  [
    'InventoryEvent',
    'BlockEvent',
    'PlayerMoveEvent',
]

Log all events except player-related ones and inventory open event

whitelist = [ '*' ]

blacklist = [
    'PlayerEvent',
    'InventoryOpenEvent',
]

Building

To build the project from source, first clone it with git

git clone https://github.com/matytyma/EventLogger.git

then cd into it

cd EventLogger

and finally build using gradle, for Linux and Mac

./gradlew build

and for Windows

./gradlew.bat build

Output JAR will be located in build/libs directory

Screenshots

Screenshot of BlocCanBuildEvent log