README.md

🏓 Tuna Man: tournament manager

NOTE: WIP

Tuna Man is a Rust-powered CLI/TUI application that creates double-elimination tournaments, initially built for table tennis. Whether you're organizing a casual game night or a competitive event, it helps you manage tournaments with ease.

Features

• 💾 CSV-Based Input: Easily import players or teams from a .csv file.
• 🔓 Flexibility: Designed for table tennis tournaments in our school, but it can be used for any tournament.
• 🏆 Double-Elimination Format: Automatically creates brackets for double-elimination tournaments.

TODO

• 🖥️ TUI interface: Integration with ratatui for a sleek terminal user interface is in the works.
• 🔄 More Tournament formats: Upcoming support for multiple tournament formats eg.:
  • single-elimination
  • Round-robin
  • Swiss-system
  • any with seeding
• library?

Getting Started

Prerequisites

• Rust installed (https://www.rust-lang.org/tools/install)
• A CSV file with participants in <player/team>,<class> format (where <class> is optional)

Installation

Clone the repository:

git clone https://codeberg.org/jark/tuna-man.git
cd tuna-man

Build the project:

cargo build --release

All-in-one easy mode:

cargo install --locked --git "https://codeberg.org/jark/tuna-man"

Usage

To create a tournament, simply run the following command, providing the path to your .csv file:

tuna-man <FILE>

• example input file with class

  name,class
  Alice,11A
  Bob,9B
  Jennice,0C
  ...
  

• example input file without class

  name
  Alice
  Bob
  Jennice
  ...
  

Options:

• -h, --help: Display help message with usage details.