Skip to content

Files

Latest commit

xylium117xylium117
Update README.md
Feb 4, 2025
bf3239b · Feb 4, 2025

History

History
98 lines (76 loc) · 2.9 KB

README.md

File metadata and controls

98 lines (76 loc) · 2.9 KB

Rubidium

An interactive football simulator using FIFA24 (FC24) data and analytics

Banner

Python  NumPy  License: MIT

Table of Contents 📜

  • Overview 🌟
  • Features 📂
  • Getting Started 🚀
  • Contributing 🤝
  • Roadmap 📈
  • License 📝

Getting Started 🚀

Clone the project

git clone https://github.com/xylium117/rubidium.git

Then proceed open the directory.

cd rubidium

Setup and activate virtual environment (optional)

# To create a virtual env:
python -m venv .venv

# For activation use one of the following commands based on your OS:
source .venv/bin/activate   # On Mac / Linux
.venv\Scripts\activate.bat  # In Windows CMD
.venv\Scripts\Activate.ps1  # In Windows PowerShell

Install the required packages from the requirements.txt file

pip install -r requirements.txt

Execute the program

python simulator

View all data

cd simulator
python viewdata.py

Prerequisites 📋

To run Rubidium, Python 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 📈

  • Add trackers for season and match analytics
  • Update player roster with custom players
  • Add preliminary data visualization
  • Improve UI and UX
  • Add viewall.py script
  • Implement fuzzy matching to improve UX
  • Add more Leagues and update player roster
  • Finalise data visualisation and viewall.py script
  • Improve Match mechanics (Yellow Cards, Substitutions)
  • Player stats dump and career regression
  • Implement tournaments
    • World Cup
    • UCL
  • Implement international matches

See the open issues for a full list of proposed features (and known issues).

License 📝

This repository is licensed under the GPL License. Feel free to use and modify the code as you see fit.

Enjoy simulating Test matches! Cheers! 🍻