vkottler / gnomish-army-knife

Software tools for WoW arena analysis.

gnomish-army-knife (1.0.0)

Software tools for WoW arena analysis.

Documentation

Generated

• By sphinx-apidoc (What's sphinx-apidoc?)
• By pydoc (What's pydoc?)

Python Version Support

This package is tested with the following Python minor versions:

• python3.11
• python3.12

Platform Support

This package is tested on the following platforms:

• ubuntu-latest
• macos-latest
• windows-latest

Introduction

This project is named after an in-game item (real ones will know!).

Command-line Options

$ ./venv3.11/bin/gak -h

usage: gak [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
           {scan,noop} ...

Software tools for WoW arena analysis.

options:
  -h, --help         show this help message and exit
  --version          show program's version number and exit
  -v, --verbose      set to increase logging verbosity
  -q, --quiet        set to reduce output
  --curses           whether or not to use curses.wrapper when starting
  --no-uvloop        whether or not to disable uvloop as event loop driver
  -C DIR, --dir DIR  execute from a specific directory

commands:
  {scan,noop}        set of available commands
    scan             scan the 'World of Warcraft' directory for updates
    noop             command stub (does nothing)

Internal Dependency Graph

A coarse view of the internal structure and scale of gnomish-army-knife's source. Generated using pydeps (via mk python-deps).

gnomish-army-knife's Issues

Add a `server` command for hosting log events

This should probably be implemented as a runtimepy/conntextual application?

Can get command-line arguments from the YAML and can specify server and client connections etc.

This really just means that for now, we only need to implement the CombatLogEventConnection (do we need specific ones for TCP and WebSocket?).

Add initial scaffolding to parse combat log files

vkottler/workspace#30

We don't need to connect networking just yet, but we should lay down the code structure so that we know where/how to implement methods to parse new kinds of log events / log lines.