MarshP / dcss-morgue-analyser

A Python program to analyse your DCSS morgue folder, collate metrics, spot patterns and give hints.
The Unlicense
2 stars 0 forks source link

DCSS Morgue Analyser


Not Maintained - (2019-09) This project was a learning excercise. Now we all play on the servers it's redundant.


A Python program to analyse your Dungeon Crawl Stone Soup morgue folder, collate metrics, spot patterns and give hints.

This tool is in pre-pre-nascent-alpha I'm doing this to help me learn Python, though other contributions may make it somewhat useful.

Documentation

This readme contains only a quickstart, but that should be enough for most users.

More detailed user docs are on the project documentation pages

Contributor docs and discussions are in the project wiki.

Quick start

  1. Ensure Python 3 (download) is installed
  2. Copy the .py files in the dcss_morgue_analyser/ directory to your DCSS crawl/morgue/ directory
    • On Windows look in %AppData% for the crawl directory
    • If you intend to analyse a subset of your morgue, such as characters of one species/profession, copy those files to a new directory and use that in place of the morgue
  3. In the morgue directory open a shell or command prompt: $ Python ./morgue-analyser.py
  4. Look for an output file called dcssma-analysis.txt. This will look prettier if opened in a mardown-enabled reader.

Issues and sugestions

If you spot something, raise an issue or -- as you can almost certainly code better than I can -- fork and fix. :0)

Plans for DCSSMA

DCSSMA will start life as a simple script which takes the morgue folder location as a command line arg. It will parse the morgue .txt files and use some pretty blunt regex work to produce some metrics and report them.

Later I hope to add more efficient data handling, more refined analysis, and maybe a gui or interactive file selection shell. Maybe some link to webtiles...

Metrics

The plan is for min, max and useful derived figures -- median, mean, SD and so forth -- for a variety of metrics. But we're guided by useful questions.

And how does all that differ when the player plays different species, backgrounds and classes of background like warrior, zealot or mage?

Copyright and License

No copyright claimed on top of whatever arises naturally from publishing the repo contents in any given jurisdiction .

License is WTFPL.