Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use statistic figures #17

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ Now you can run it with `mclogalyzer`.

Alternatively you can directly run the script `mclogalyzer/mclogalyzer.py`.

## Development ##

The files are documented by epydoc standards. To generate the documentation call
```
epydoc mclogalyzer/mclogalyzer.py
```
which generates the documenation in the html folder.

## How to use the script ##

You have to pass the path to the Minecraft server log directory and the path to an
Expand All @@ -53,3 +61,6 @@ to generate the report of last month or last week.
You can use the whitelist as a guide using `--w whitelist.json`. If so, users
not included in the whitelist will be removed from final results, and users not
present in log file but present in whitelist will be added to the output.

You can add full chatlog history by providing `--chat`. This will result in
large file size and provide a chat tab at the top menu.
Loading