Dixtribution is a CLI tool to gather stats and test the performance of your Dix bot using the onze game master.
Table of Contents
git clone https://github.com/Ecoral360/dixtribution.git
cd dixtribution
hatch shell
pip install your/path/to/onze
dixtribution --version # should output the version
Dixtributors are middleware programs that take the debug messages from onze and produce stats, analytics, and much more from it!
You can add dixtributors to your execution with the -d <DIXTRIBUTOR_NAME>
attribute in the dixtribution
cli command.
For example, the plt_final
dixtributor plots the final score of each game in a graph.
To get a list of all the supported Dixtributors, run the
dixtribution --help
command
To add your custom Dixtributor:
- Add a python file in the
src/dixtribution/dixtributors
directory;The name of the file is the name you will use (in the
-d
argument of thedixtribution
command) to trigger you dixtributor. - In that file, add a class that inherits from Dixtributor;
- Add the required methods from the Dixtributor abstract class to your class;
- Add
__dixtributor__ = <YourDixtributorClass>
at the end of your dixtributor python file; - Run the
dixtribution
command with the-d <your-CLI_NAME>
to see it in action!
dixtribution
is distributed under the terms of the MIT license.