Git Product home page Git Product logo

game_scheduler's Introduction

Game Scheduling System Cover

Game Scheduling System

Purpose

The Game Scheduling System is designed to automate the process of organizing board game sessions, ensuring an optimal experience for all participants. It accounts for the availability of games, player preferences, and the need for game teachers, creating a schedule that maximizes player engagement and game variety.

Approach

The system is built around three core components:

  • Game: Represents a board game, detailing the required player count and the designated teacher(s).
  • Player: Represents a participant, including their game preferences to guide the scheduling process.
  • Schedule: Manages the allocation of games to time slots, considering player preferences, ensuring every game has a teacher, and preventing any player from being scheduled for two games simultaneously.

The scheduling logic accounts for the number of games that can be played simultaneously and the total number of slots available for the game day. It prioritizes filling slots with the most preferred games, ensuring each player participates in every slot, and respects the minimum and maximum player counts for each game.

Usage

Setting Up Your Environment

  1. Clone the repository: Obtain the project code by cloning this repository to your local machine.
  2. Install dependencies: This project primarily uses Python's standard library. Ensure your Python environment is set up and ready.

Preparing Data

  1. Game and Player Data: Populate a CSV file in the data/ directory with game details and player preferences. The system automatically selects the newest CSV file from this directory.
  2. Format: Ensure your CSV follows the required format, with columns for game names, player counts, teachers, alternate teachers, and player preferences.

Running the System

Navigate to the project root and execute the main script:

python src/main.py

This command runs the scheduling system, which reads the game and player data, generates a schedule, and prints it to the console.

Customizing the Schedule

Modify the parameters in main.py to adjust the number of simultaneous games and total game slots based on your specific needs.

Contributing

Contributions to the Game Scheduling System are welcome. Whether it's feature enhancements, bug fixes, or documentation improvements, feel free to fork the repository and submit pull requests.

License

This project is open-source and available under MIT License.

game_scheduler's People

Contributors

jbultema avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.