Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xylium117/pavillion
An interactive cricket simulator that allows you to simulate Test matches
https://github.com/xylium117/pavillion
cricket cricket-analytics cricket-data cricket-scorecard cricket-stats python simulator
Last synced: about 1 month ago
JSON representation
An interactive cricket simulator that allows you to simulate Test matches
- Host: GitHub
- URL: https://github.com/xylium117/pavillion
- Owner: xylium117
- License: gpl-3.0
- Created: 2024-09-16T17:06:43.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-10-15T10:00:25.000Z (4 months ago)
- Last Synced: 2024-11-14T02:20:38.100Z (3 months ago)
- Topics: cricket, cricket-analytics, cricket-data, cricket-scorecard, cricket-stats, python, simulator
- Language: Python
- Homepage:
- Size: 3.04 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pavillion
An interactive cricket simulator which can simulate matches between custom teams and historical Test match lineups.
---
[](https://github.com/xylium117/pavillion/blob/master/LICENSE.md)
## Table of Contents 📜
- Overview 🌟
- Features 📂
- Getting Started 🚀
- Contributing 🤝
- Roadmap 📈
- License 📝
## Overview 🌟
Pavillion allows you to simulate exciting cricket matches using both custom and historical teams. Whether you're a cricket enthusiast looking to relive classic International Test matches or a fan eager to create your own teams, Pavillion has something for you.
## Features 📂
Here are some of the exciting projects you'll find in this gallery:
1. **Custom Team**
- *Description:* Create your own teams by selecting players from a roster of cricketers between 1877 to 2020, customizing stats, and defining new lineups.
2. **National Teams**
- *Description:* Choose from a variety of natinoal teams and legendary players to recreate iconic matches. If you're feeling lazy, specify an era, and the computer will create the best possible team for that nation with players from that era.
3. **Test Match Simulation**
- *Description:* Simulate matches with "real"-time updates and get realistic scores in a sleek format. A player's ability varies indefinitely with each simulation and is scaled to fit into the comparison of the modern era. All players begin with average stats compiled from their playing career.
4. **Detailed Match Reports**
- *Description:* Receive comprehensive match summaries, including player performances, scores, and key events.
5. **Configurable Rules**
- *Description:* Adjust in-game settings, weather, field and pitch conditions, as well as player stats and data.
Don't hesitate to explore and give these projects a try! Feedback and contributions are always welcome. 🙌
## Getting Started 🚀
1. To get started, simply open the Terminal and clone the project.
```bat
git clone https://github.com/xylium117/pavillion.git
```
2. Then proceed open the directory.
```bat
cd pavillion
```
3. Run a python script of your choice :
```bat
python script.py
```
**List of Runnable Scripts**
`custom.py` - Simulate a Test series between 2 custom teams
`customleague.py`- Simulate a league with a number of custom teams
`historical.py` - Simulate a Test series between 2 National teams (with players from a certain era)
`historicalleague.py` - Simulate a league with a number of National teams (with players from a certain era)
### Prerequisites 📋
To run Pavillion, [Python](https://www.python.org/ftp/python/3.12.6/python-3.12.6-amd64.exe) must be downloaded. An IDE is also suggested if you want to contribute to the code. 🏗️
## Contributing 🤝
Contributions are welcome! If you have any improvements, bug fixes, or new projects to add to this gallery, please follow these steps:
1. Fork this repository.
2. Create a new branch for your feature (`git checkout -b feature-name`).
3. Make your changes and commit them (`git commit -m 'Add new project'`).
4. Push to your branch (`git push origin feature-name`).
5. Open a pull request and describe your changes. 🚀🔗
## Roadmap 📈
- [x] Add ICC All-Time teams in presets
- [x] Fix bit-parsing error
- [x] Update README.md
- [ ] Custom Player designer
- [ ] Multiple formats
- [ ] ODI
- [ ] T20I
- [ ] Player Stat improvement analysis
See the [open issues](https://github.com/xylium117/pavillion/issues) for a full list of proposed features (and known issues).
## License 📝
This repository is licensed under the [MIT License](LICENSE). Feel free to use and modify the code as you see fit.
---
Enjoy simulating Test matches! Cheers! 🍻