🏏 CricField

CricField is an interactive visualizer for placing cricket fielders on a ground. Designed just for fun exploration.

---

📦 Features

• Add and move fielders
• Enforces field restrictions (e.g., number of players outside inner ring)
• Right/Left-handed batter support
• Visual guide to standard fielding positions
• Minimalist design with full-screen experience

---

🛠️ Installation

I recommend using Miniforge and Python 3.12 for compatibility.

1. Clone the repository

git clone https://github.com/sangeethankumar/cricfield.git
cd cricfield

2. Create and activate a conda environment

conda create -n cricfield python=3.12
conda activate cricfield

3. Install dependencies

pip install -r requirements.txt

4. Install the app locally (editable mode)

pip install .

---

🚀 Launch the App

After installation:

cricfield

If everything is working, you should see the CricField Settings Menu pop up!

---

🎮 Controls

• Mouse Click – Place or select a player
• Arrow Keys – Move selected player
• ESC – Quit

---

🧩 Settings Menu

Choose:

• Total players on field
• Max players outside inner ring
• Fielder movement speed
• Fullscreen or windowed
• Right- or Left-handed batter

---

📁 Folder Structure (Simplified)

cricfield/
├── src/cricfield/
│   ├── main.py
│   ├── adapters/
│   ├── core/
│   └── domain/
├── assets/
│   └── icon.png
├── requirements.txt
├── README.md
├── pyproject.toml

---

🧪 Development Mode

Install the app in editable mode

pip install -e .

The -e flag lets you make changes to the code and re-run without reinstalling.

This project is modular and extensible. To make changes:

1. Modify code inside src/cricfield/
2. Run cricfield again — no reinstall needed!

---

🤝 Contributions

Pull requests and feedback are welcome! Feel free to open an issue.

---