Ecoral360 / dixtribution

dixtribution

---

Dixtribution is a CLI tool to gather stats and test the performance of your Dix bot using the onze game master.

Table of Contents

• Installation
• Dixtributors
• Custom Dixtributors
• License

Installation

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

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

Adding a custom Dixtributor

To add your custom Dixtributor:

1. 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 the dixtribution command) to trigger you dixtributor.

2. In that file, add a class that inherits from Dixtributor;
3. Add the required methods from the Dixtributor abstract class to your class;
4. Add __dixtributor__ = <YourDixtributorClass> at the end of your dixtributor python file;
5. Run the dixtribution command with the -d <your-CLI_NAME> to see it in action!

License

dixtribution is distributed under the terms of the MIT license.