Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
doej1367 authored Mar 15, 2022
1 parent 6ee4d6a commit 324e8e3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Minecraft Chat Log Filter
A Java tool to filter the chat messages logged in all Minecraft log files available using a specialized regex syntax and the simple press of a button

## How to use
1. Download the [latest release](https://github.com/doej1367/MinecraftChatLogFilter/releases) and execute the jar file
2. Enter a valid query string into the first box (more about that in the syntax section)
3. \[Optional\] Add custom minecraft directories with the right `Add custom .minecraft folder locations` button
4. Click the left `Start analyzing currently known .minecraft folders` button and wait for your results

## Syntax
The syntax in the core is a simple RegEx syntax with a speciallities so that it all works together with the concept of multiple chat log lines. Here are the main features:
- `(regex)` - filters all lines that match the provided regex
- `(regex1)|(regex2)` - filters all lines that match either one of the two provided regex
Expand All @@ -12,4 +19,5 @@ These three can be combined to one big regex. One example for this would be a re

More examples can be found and posted in the [Discussions section](https://github.com/doej1367/MinecraftChatLogFilter/discussions/categories/regex-examples)

## Screenshot
![MinecraftChatSearch](screenshots/screenshot01.png)

0 comments on commit 324e8e3

Please sign in to comment.