How techinqproj-2025-s1/2025s1_tip_c08_team3 works
Project type and purpose
• This is a Python-based desktop “game launcher” application that bundles several mini-games (MathFlip, TetrisMath, Sequence Game, Spell Quest, Typing Game, Word Pop).
• The launcher module provides a unified UI, settings, and high-score management. Each game is a self-contained submodule under games/.
File structure
• Top-level packages and files:
• launcher/ – core application (UI, menus, button widgets, settings, score management)
• games/ – one subdirectory per game, each with its own game logic, UI, constants, and persistence files (high-score JSON or text)
• config.json – global configuration for the launcher or games
• scores/ – aggregate score storage (e.g., tetris_math_scores.json)
• launcher.py – entry point that bootstraps the launcher UI
• tests/ + pytest.ini – end-to-end and unit tests for launcher and games
• GitHub Actions workflows under .github/workflows – CI for linting and tests
• Notice each game submodule follows a similar MVC-like breakdown: constants, UI code, game logic, persistence (highscores/leaderboards).
README for additional insights
• The README itself is focused on GitHub rules and CI, but it confirms that PyLint is integrated and that branches/pr workflows are used to enforce quality checks.
a. Main components:
• User Interface Layer (Launcher UI, Menus, Buttons)
• Game Modules (MathFlip, TetrisMath, etc.)
• Configuration Manager (reads config.json)
• Persistence Layer (reads/writes JSON/text files in games/* and scores/)
• Test Harness (pytest suite)
• CI Pipeline (GitHub Actions → Linting & Tests)
b. Relationships & interactions:
• User → clicks on Launcher UI → invokes Game Module
• Each Game Module → communicates with Persistence Layer to load/save highscores/leaderboards
• Launcher & Games → read global or per-game config from Configuration Manager
• Tests → import and exercise Launcher and Game modules (unit/integration)
• CI Pipeline → runs lint and pytest on commits/PRs
c. Architectural patterns & principles:
• Modular design: each game is an independent package plugged into a common launcher framework
• MVC-like separation within each game (constants/model, UI/view, game logic/controller)
• Single entry point (launcher.py) for the application
• Externalized configuration and persistence to JSON/text files
• Automated pipelines enforcing code quality
d. Key technologies & libraries:
• Python 3.x, pytest, PyLint
• Standard library for JSON, file I/O, and possibly a GUI library (e.g., pygame or tkinter if used indirectly in ui.py)
Elements
• From User → Launcher UI → Game Module
• From Launcher/Game → Configuration Manager (read)
• From Launcher/Game → Persistence Layer (read/write)
• From CI Pipeline → triggers Lint & Tests → Test Suite
• Game logic modules in another