Basic Only version step 1

.github/copilot-instructions.md

@@ -1,6 +1,13 @@
-minimal changes to existing code
-preserve functionality when possible
-clear and concise comments
-no test unless specified
-no plan unless specified
-no compile unless specified
+# Copilot Instructions
+
+## General Guidelines
+- Minimal changes to existing code
+- Preserve functionality when possible
+- Clear and concise comments
+- No test unless specified
+- No plan unless specified
+- No compile unless specified
+
+## Project-Specific Rules
+- Remove AI generation of wordlists and audio system from the basic codebase
+- Keep challenge mode/HF storage and PWA support in the basic codebase

battlewords/modules/__init__.py

@@ -21,14 +21,11 @@ from .storage import (
 
 from .constants import (
     APP_SETTINGS,
-    AI_MODELS,
     HF_API_TOKEN,
     CRYPTO_PK,
     HF_REPO_ID,
     SPACE_NAME,
     SHORTENER_JSON_FILE,
-    USE_HF_WORDS,
-    HF_WORD_LIST_REPO_ID,
     MAX_DISPLAY_ENTRIES,
     TMPDIR,
     upload_file_types,
@@ -71,14 +68,11 @@ __all__ = [
 
     # constants.py
     'APP_SETTINGS',
-    'AI_MODELS',
     'HF_API_TOKEN',
     'CRYPTO_PK',
     'HF_REPO_ID',
     'SPACE_NAME',
     'SHORTENER_JSON_FILE',
-    'USE_HF_WORDS',
-    'HF_WORD_LIST_REPO_ID',
     'MAX_DISPLAY_ENTRIES',
     'TMPDIR',
     'upload_file_types',

battlewords/modules/constants.py

@@ -23,20 +23,8 @@ CRYPTO_PK = os.getenv("CRYPTO_PK", None)
 HF_REPO_ID = os.getenv("HF_REPO_ID", "Surn/Storage")
 SPACE_NAME = os.getenv('SPACE_NAME', 'Surn/BattleWords')
 SHORTENER_JSON_FILE = "shortener.json"
-USE_HF_WORDS = os.getenv("USE_HF_WORDS", "false").lower() == "true"
-HF_WORD_LIST_REPO_ID = os.getenv("HF_WORD_LIST_REPO_ID", "ysharma/Chat_with_Meta_llama3_1_8b")
 MAX_DISPLAY_ENTRIES = int(os.getenv("MAX_DISPLAY_ENTRIES", 25))
 
-# List of smaller, faster fallback models if the primary one fails
-AI_MODELS = [
-    "microsoft/Phi-3-mini-4k-instruct",    
-    "meta-llama/Llama-3.1-8B-Instruct",
-    "google/gemma-2b-it",
-    "distilbert/distilgpt2",
-    "mistralai/Mistral-7B-Instruct-v0.3",
-    "NousResearch/Hermes-2-Pro-Llama-3-8B"    
-]
-
 # ---------------------------------------------------------------------------
 # Application Settings
 # ---------------------------------------------------------------------------
@@ -63,13 +51,7 @@ def load_settings() -> Dict[str, Any]:
         "show_incorrect_guesses": True,
         "enable_free_letters": False,
         "show_challenge_links": True,
-        
-        # Audio settings
-        "sound_effects_enabled": True,
-        "sound_effects_volume": 30,
-        "music_enabled": False,
-        "music_volume": 10,
-        
+
         # Game defaults
         "default_wordlist": "classic.txt",
         "default_game_mode": "classic",

battlewords/ui.py

@@ -18,17 +18,8 @@ from .generator import generate_puzzle
 from .logic import build_letter_map, reveal_cell, guess_word, is_game_over, compute_tier, auto_mark_completed_words, hidden_word_display
 from .models import Coord, GameState, Puzzle
 from .word_loader import get_wordlist_files, load_word_list, compute_word_difficulties
-from .audio import (
-    _get_music_dir,
-    get_audio_tracks,
-    _load_audio_data_url,
-    _mount_background_audio,
-    _inject_audio_control_sync,
-    play_sound_effect,
-)
 from .game_storage import load_game_from_sid, save_game_to_hf, get_shareable_url, add_user_result_to_game
-from .settings_page import render_settings_page
-from .ui_helpers import render_footer, inject_styles, fig_to_pil_rgba, ocean_background_css, inject_ocean_layers, pwa_service_worker, show_spinner, fade_out_spinner, start_root_fade_in, finish_root_fade_in
+from .ui_helpers import inject_styles, fig_to_pil_rgba, ocean_background_css, inject_ocean_layers, pwa_service_worker, show_spinner, fade_out_spinner, start_root_fade_in, finish_root_fade_in
 
 # --- Spinner context manager for custom spinner ---
 class CustomSpinner:
@@ -157,13 +148,6 @@ def _init_session() -> None:
         if "show_grid_ticks" not in st.session_state:
             st.session_state.show_grid_ticks = False
 
-        # --- Add enable sound effects ---
-        if "enable_sound_effects" not in st.session_state:
-            st.session_state.enable_sound_effects = False
-
-        if "hide_footer" not in st.session_state:
-            st.session_state["hide_footer"] = False
-
 def _new_game() -> None:
      spinner_placeholder = st.empty()
      with CustomSpinner(spinner_placeholder, "Initializing New Game..."):
@@ -172,12 +156,6 @@ def _new_game() -> None:
          show_grid_ticks = st.session_state.get("show_grid_ticks", False)
          spacer = st.session_state.get("spacer",1)
          show_incorrect_guesses = st.session_state.get("show_incorrect_guesses", False)
-         # --- Preserve music and effects settings ---
-         music_enabled = st.session_state.get("music_enabled", False)
-         music_track_path = st.session_state.get("music_track_path")
-         music_volume = st.session_state.get("music_volume",15)
-         effects_volume = st.session_state.get("effects_volume",25)
-         enable_sound_effects = st.session_state.get("enable_sound_effects", True)
          # NEW: Preserve Show Challenge Share Links
          show_challenge_share_links = st.session_state.get("show_challenge_share_links", False)
 
@@ -189,13 +167,6 @@ def _new_game() -> None:
          st.session_state.show_grid_ticks = show_grid_ticks
          st.session_state.spacer = spacer
          st.session_state.show_incorrect_guesses = show_incorrect_guesses
-         # --- Restore music/effects settings ---
-         st.session_state.music_enabled = music_enabled
-         if music_track_path:
-            st.session_state.music_track_path = music_track_path
-         st.session_state.music_volume = music_volume
-         st.session_state.effects_volume = effects_volume
-         st.session_state.enable_sound_effects = enable_sound_effects
          # NEW: Restore Show Challenge Share Links
          st.session_state.show_challenge_share_links = show_challenge_share_links
 
@@ -689,19 +660,6 @@ def _render_grid(state: GameState, letter_map, show_grid_ticks: bool = True):
         # Note: letter_map is static and built once in _init_session(), no need to rebuild
         _sync_back(state)
 
-        # Play sound effect based on hit or miss
-        action = (state.last_action or "").strip()
-        if action.startswith("Revealed '"):
-            play_sound_effect(
-                "hit",
-                volume=(st.session_state.get("effects_volume", 50) / 100),
-            )
-        elif action.startswith("Revealed empty"):
-            play_sound_effect(
-                "miss",
-                volume=(st.session_state.get("effects_volume", 50) / 100),
-            )
-
         st.rerun()
 
 def _render_hit_miss(state: GameState):
@@ -939,12 +897,10 @@ def _render_guess_form(state: GameState):
                 if correct:
                     st.session_state.radar_gif_path = None
                     st.session_state.radar_gif_signature = None
-                    play_sound_effect("correct_guess", volume=(st.session_state.get("effects_volume", 50) / 100))
                 else:
                     # Update incorrect guesses list - keep only last 10
                     st.session_state.incorrect_guesses.append(guess_text)
                     st.session_state.incorrect_guesses = st.session_state.incorrect_guesses[-10:]
-                    play_sound_effect("incorrect_guess", volume=(st.session_state.get("effects_volume", 50) / 100))
                 st.rerun()
 
 
@@ -1083,16 +1039,6 @@ def _render_score_panel(state: GameState):
 # -------------------- Game Over Dialog --------------------
 
 def _game_over_content(state: GameState) -> None:
-    # Play congratulations music (not sound effect) as background if enabled
-    music_dir = _get_music_dir()
-    congrats_music_path = os.path.join(music_dir, "congratulations.mp3")
-    if st.session_state.get("music_enabled", False) and os.path.exists(congrats_music_path):
-        src_url = _load_audio_data_url(congrats_music_path)
-        # Play once (no loop) at configured volume
-        _mount_background_audio(enabled=True, src_data_url=src_url, volume=(st.session_state.get("music_volume", 100)) / 100, loop=False)
-    else:
-        _mount_background_audio(False, None, 0.0)
-
     # Set end_time if not already set
     if state.end_time is None:
         st.session_state.end_time = datetime.now()
@@ -1394,7 +1340,6 @@ def _game_over_content(state: GameState) -> None:
     # Dialog actions
     if st.button("Close", key="close_game_over"):
         st.session_state["show_gameover_overlay"] = False
-        st.session_state["remount_background_audio"] = True  # <-- set flag
         st.rerun()
 
 # Prefer st.dialog/experimental_dialog; fallback to st.modal if unavailable
@@ -1418,32 +1363,8 @@ def _render_game_over(state: GameState):
     spinner_placeholder = st.empty()
     with CustomSpinner(spinner_placeholder, "Game Over..."):
         visible = bool(st.session_state.get("show_gameover_overlay", True)) and is_game_over(state)
-        music_dir = _get_music_dir()
         if visible:
-            # Mount congratulations music (play once, do not loop) only if music is enabled
-            congrats_music_path = os.path.join(music_dir, "congratulations.mp3")
-            if st.session_state.get("music_enabled", False) and os.path.exists(congrats_music_path):
-                src_url = _load_audio_data_url(congrats_music_path)
-                _mount_background_audio(enabled=True, src_data_url=src_url, volume=(st.session_state.get("music_volume", 100)) / 100, loop=False)
-            else:
-                _mount_background_audio(False, None, 0.0)
             _game_over_dialog(state)
-        else:
-            # Only play background music if music is enabled
-            if st.session_state.get("music_enabled", False):
-                # Prefer user-selected track
-                track_path = st.session_state.get("music_track_path")
-                if track_path and os.path.exists(track_path):
-                    src_url = _load_audio_data_url(track_path)
-                    _mount_background_audio(True, src_url, (st.session_state.get("music_volume", 100)) / 100)
-                else:
-                    # Fallback to a default background track if available
-                    background_path = os.path.join(music_dir, "background.mp3")
-                    if os.path.exists(background_path):
-                        src_url = _load_audio_data_url(background_path)
-                        _mount_background_audio(True, src_url, (st.session_state.get("music_volume", 100)) / 100)
-                    else:
-                        _mount_background_audio(False, None, 0.0)
 
 def _on_game_option_change() -> None:
     """
@@ -1502,10 +1423,6 @@ def run_app():
     except Exception:
         params = {}
 
-    # handle no footer query string param (for embedding use cases)
-    if "nofooter" in params:
-        st.session_state["hide_footer"] = True
-
     # Handle overlay dismissal
     if params.get("overlay") == "0":
         # Clear param and remember to hide overlay this session
@@ -1515,54 +1432,14 @@ def run_app():
             pass
         st.session_state["hide_gameover_overlay"] = True
 
-    # Handle page navigation via query params
-    page = params.get("page") or "play"
-
     # Show spinner on initial load
     if not st.session_state.get("initial_page_loaded", False):
         spinner_placeholder = st.empty()
         with CustomSpinner(spinner_placeholder, "Initial Load..."):
             st.session_state["initial_page_loaded"] = True
-            st.session_state["last_nav_page"] = page    
-            # st.rerun()
-
-    # Show spinner when navigating via menu (query param page change)
-    last_nav_page = st.session_state.get("last_nav_page")
-    if last_nav_page is not None and last_nav_page != page:
-        spinner_placeholder = st.empty()
-        with CustomSpinner(spinner_placeholder, "Loading..."):
-            st.session_state["last_nav_page"] = page            
-            st.rerun()
-
-    # One-time spinner on initial display of the main UI.
-    # if page == "play" and not st.session_state.get("initial_page_loaded", False):
-    #     spinner_placeholder = st.empty()
-    #     with CustomSpinner(spinner_placeholder, "Loading Game..."):
-    #         st.session_state["initial_page_loaded"] = True            
-    #         st.rerun()
 
-    if page == "settings":
-        spinner_placeholder = st.empty()
-        with CustomSpinner(spinner_placeholder, "Loading Settings..."):
-            st.markdown(ocean_background_css, unsafe_allow_html=True)
-            #inject_ocean_layers()
-            inject_styles()
-            render_settings_page(_on_game_option_change)
-            if  st.session_state["hide_footer"] is not True:
-                render_footer(current_page="settings", params=params)
-        return
-
-    if page == "leaderboard":
-        spinner_placeholder = st.empty()
-        with CustomSpinner(spinner_placeholder, "Loading Leaderboard..."):
-            st.markdown(ocean_background_css, unsafe_allow_html=True)
-            #inject_ocean_layers()
-            inject_styles()
-            st.header("Leaderboard")
-            st.caption("Leaderboard UI will be added as part of the upgrade checklist.")
-            if  st.session_state["hide_footer"] is not True:
-                render_footer(current_page="leaderboard", params=params)
-        return
+    # Basic branch: only render the play experience
+    # Settings and leaderboard pages are disabled
 
     # Handle game_id for loading shared games
     if "game_id" in params and "shared_game_loaded" not in st.session_state:
@@ -1614,8 +1491,6 @@ def run_app():
     state = _to_state()
     if is_game_over(state) and not st.session_state.get("hide_gameover_overlay", False):
         _render_game_over(state)
-    if  st.session_state["hide_footer"] is not True:
-        render_footer(current_page="play", params=params)
     finish_root_fade_in(2.0)
 
 def _render_game_tab():

specs/basic.mdx

@@ -0,0 +1,138 @@
+# Battlewords: Basic Branch Requirements
+
+**Branch:** `basic`
+
+This document defines the “basic” version scope for Battlewords on the `basic` branch. It intentionally limits features to a minimal, default-settings single-player experience.
+
+## Tech Stack
+- Python 3.10+
+- Streamlit (UI)
+- matplotlib (radar)
+- numpy (tick helpers)
+- Pillow (GIF writer)
+
+## In Scope
+
+### Default gameplay only
+- The game uses **default settings**.
+- No user-configurable options are required.
+- State remains local (Streamlit session state) as implemented in the core app flow.
+
+### UI
+- A single play experience accessible from `app.py`.
+- Core UI elements required to play:
+  - 12×12 grid
+  - Reveal action
+  - Guess form
+  - Score display
+  - Game over summary
+
+### Layout constraints
+- No footer navigation.
+- No sidebar.
+
+## Out of Scope (Basic Branch)
+
+### Settings page
+- The app **does not need** a settings page.
+- No query-param routing to a settings page is required.
+- Any settings-related UI should be omitted/disabled in this branch.
+
+### Leaderboard
+- The app **does not need** a leaderboard.
+- No local or remote leaderboard storage is required.
+- No UI navigation or pages for leaderboard are required.
+
+### AI generation of wordlists
+- The basic branch does **not** include AI-generated wordlists or HF-model-backed word generation.
+- Related AI model configuration (for example `AI_MODELS`, `USE_HF_WORDS`, `HF_WORD_LIST_REPO_ID`) should be removed/unused in this branch.
+
+### Audio (music + sound effects)
+- The basic branch does **not** include background music or sound effects.
+- Audio mounting via `component.html` and any audio assets/modules should be removed/unused in this branch.
+
+### Tests
+- The basic branch does **not** include tests or a `tests` folder.
+
+## Notes
+- Feature work for Settings/Leaderboard should live on non-`basic` branches.
+
+## Basic Functions Kept
+
+The following functions are retained in the basic branch:
+- Game initialization and puzzle generation
+- Word list loading and validation
+- Reveal cell action
+- Guess word action
+- Score calculation and tier assignment
+- Radar visualization
+- Game over summary display
+
+## UI Transitions and Effects
+
+The basic branch uses:
+- `CustomSpinner` for smooth loading and transition effects (New Game, initial load, Game Over/Congratulations popups).
+- Streamlit CSS, markup, and `component.html` for UI styling and transition overlays.
+
+
+## Codebase Constraints (Basic Branch)
+
+### Navigation / routing
+- No query-param navigation to non-game pages.
+- Remove/disable any routing paths such as `?page=settings` and `?page=leaderboard`.
+- The basic branch should only render the play experience.
+
+### Word list sources
+- Word lists must be loaded from local files in `battlewords/words/`.
+- Do not fetch or generate word lists via Hugging Face models or other AI inference.
+
+### Component usage
+- `component.html` is allowed for UI transitions/effects (spinners, scroll-to-anchor, overlays).
+- `component.html` must not be used for audio mounting in the basic branch.
+
+## Possible features to remove
+
+The following features are currently included, but may be considered for removal in an even more minimal version:
+- Challenge mode / Share Links / Remote Storage (HF)
+- PWA support (service worker, manifest, installability)
+
+
+## Implementation Checklist
+
+- App starts with no errors.
+- New Game transition remains smooth (uses `CustomSpinner`).
+- Core gameplay works end-to-end (reveal, guess, scoring, radar, game over).
+- Game Over / Congratulations popup behaves correctly and remains smooth.
+- Challenge mode works via `?game_id=...` (load, play, submit/share).
+- PWA support remains functional (service worker/manifest still injected/served).
+- No audio playback occurs (no background music, no sound effects).
+- No AI/HF-model-backed word list generation occurs (local wordlists only).
+- No settings/leaderboard pages are reachable (`?page=settings` / `?page=leaderboard` disabled).
+- No footer navigation and no sidebar are rendered.
+
+
+
+Initial Proposed Prompt:
+
+```text
+You are working in the basic branch. Follow .github/copilot-instructions.md (minimal changes, preserve functionality, clear concise comments, no tests unless asked). Also follow basic.mdx requirements.
+Goal: simplify the codebase to match the basic version.
+Must keep:
+•	Core gameplay (grid reveal, guessing, scoring, radar, game over)
+•	CustomSpinner and CSS/markup/components.html usage for smooth transitions (initial load, New Game, Game Over popup)
+•	Challenge mode / share links / Remote Storage (HF) feature
+•	PWA support (service worker / manifest integration)
+Must remove/disable from the basic codebase:
+•	AI generation of wordlists / HF-model-backed word generation (remove or make unused AI_MODELS, USE_HF_WORDS, HF_WORD_LIST_REPO_ID and any related code paths)
+•	Audio system (no background music, no sound effects; remove imports/usage of audio.py, audio assets, and any audio mounting via components.html)
+Additional constraints:
+•	No footer and no sidebar in the UI.
+•	No query-param navigation for ?page=settings or ?page=leaderboard; basic should only render the play experience.
+•	Word lists must load only from local files in battlewords/words/.
+Deliverable:
+•	Make the smallest set of code changes across the repo to enforce the above.
+•	Update app.py / ui.py routing accordingly.
+•	Remove now-unused modules/files only if they are truly unused after edits.
+•	Summarize exactly which files you changed and why.
+•	Validate the result against the "Implementation Checklist" section in this document.
+```

tests/test_apptest.py

@@ -1,7 +0,0 @@
-# file: D:/Projects/Battlewords/tests/test_apptest.py
-from streamlit.testing.v1 import AppTest
-
-def test_app_runs():
-    at = AppTest.from_file("app.py")
-    at.run()
-    assert not at.exception

tests/test_compare_difficulty_functions.py

@@ -1,237 +0,0 @@
-# file: tests/test_compare_difficulty_functions.py
-import os
-import sys
-import pytest
-
-# Ensure the modules path is available
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
-
-from battlewords.modules.constants import HF_API_TOKEN
-from battlewords.modules.storage import gen_full_url, _get_json_from_repo, HF_REPO_ID, SHORTENER_JSON_FILE
-from battlewords.word_loader import compute_word_difficulties, compute_word_difficulties2, compute_word_difficulties3
-
-# Ensure the token is set for Hugging Face Hub
-if HF_API_TOKEN:
-    os.environ["HF_API_TOKEN"] = HF_API_TOKEN
-
-# Define sample_words as a global variable
-sample_words = []
-
-def test_compare_difficulty_functions_for_challenge(capsys):
-    """
-    Compare compute_word_difficulties, compute_word_difficulties2, and compute_word_difficulties3
-    for all users in a challenge identified by short_id.
-    """
-    global sample_words  # Ensure we modify the global variable
-
-    # Use a fixed short id for testing
-    short_id = "hDjsB_dl"
-
-    # Step 1: Resolve short ID to full URL
-    status, full_url = gen_full_url(
-        short_url=short_id,
-        repo_id=HF_REPO_ID,
-        json_file=SHORTENER_JSON_FILE
-    )
-
-    if status != "success_retrieved_full" or not full_url:
-        print(
-            f"Could not resolve short id '{short_id}'. "
-            f"Status: {status}. "
-            f"Check repo '{HF_REPO_ID}' and mapping file '{SHORTENER_JSON_FILE}'."
-        )
-        captured = capsys.readouterr()
-        assert "Could not resolve short id" in captured.out
-        assert not full_url, "full_url should be empty/None on failure"
-        print("settings.json was not found or could not be resolved.")
-        return
-
-    print(f"✓ Resolved short id '{short_id}' to full URL: {full_url}")
-
-    # Step 2: Extract file path from full URL
-    url_parts = full_url.split("/resolve/main/")
-    assert len(url_parts) == 2, f"Invalid full URL format: {full_url}"
-    file_path = url_parts[1]
-
-    # Step 3: Download and parse settings.json
-    settings = _get_json_from_repo(HF_REPO_ID, file_path, repo_type="dataset")
-    assert settings, "Failed to download or parse settings.json"
-    print(f"✓ Downloaded settings.json")
-
-    # Validate settings structure
-    assert "challenge_id" in settings
-    assert "wordlist_source" in settings
-    assert "users" in settings
-    
-    wordlist_source = settings.get("wordlist_source", "wordlist.txt")
-    users = settings.get("users", [])
-    
-    print(f"\nChallenge ID: {settings['challenge_id']}")
-    print(f"Wordlist Source: {wordlist_source}")
-    print(f"Number of Users: {len(users)}")
-
-    # Step 4: Determine wordlist file path
-    # Assuming the wordlist is in battlewords/words/ directory
-    words_dir = os.path.join(os.path.dirname(__file__), "..", "battlewords", "words")
-    wordlist_path = os.path.join(words_dir, wordlist_source)
-    
-    # If wordlist doesn't exist, try classic.txt as fallback
-    if not os.path.exists(wordlist_path):
-        print(f"⚠ Wordlist '{wordlist_source}' not found, using 'classic.txt' as fallback")
-        wordlist_path = os.path.join(words_dir, "classic.txt")
-    
-    assert os.path.exists(wordlist_path), f"Wordlist file not found: {wordlist_path}"
-    print(f"✓ Using wordlist: {wordlist_path}")
-
-    # Step 5: Compare difficulty functions for each user
-    print("\n" + "="*80)
-    print("DIFFICULTY COMPARISON BY USER")
-    print("="*80)
-
-    all_results = []    
-
-    for user_idx, user in enumerate(users, 1):
-        user_name = user.get("name", f"User {user_idx}")
-        word_list = user.get("word_list", [])
-        sample_words += word_list  # Update the global variable with the latest word list
-        
-        if not word_list:
-            print(f"\n[{user_idx}] {user_name}: No words assigned, skipping")
-            continue
-
-        print(f"\n[{user_idx}] {user_name}")
-        print(f"     Words: {len(word_list)} words")
-        print(f"     Sample: {', '.join(word_list[:5])}{'...' if len(word_list) > 5 else ''}")
-
-        # Compute difficulties using all three functions
-        total_diff1, difficulties1 = compute_word_difficulties(wordlist_path, word_list)
-        total_diff2, difficulties2 = compute_word_difficulties2(wordlist_path, word_list)
-        total_diff3, difficulties3 = compute_word_difficulties3(wordlist_path, word_list)
-
-        print(f"\n     Function 1 (compute_word_difficulties):")
-        print(f"       Total Difficulty: {total_diff1:.4f}")
-        print(f"       Words Processed: {len(difficulties1)}")
-        
-        print(f"\n     Function 2 (compute_word_difficulties2):")
-        print(f"       Total Difficulty: {total_diff2:.4f}")
-        print(f"       Words Processed: {len(difficulties2)}")
-
-        print(f"\n     Function 3 (compute_word_difficulties3):")
-        print(f"       Total Difficulty: {total_diff3:.4f}")
-        print(f"       Words Processed: {len(difficulties3)}")
-
-        # Calculate statistics
-        if difficulties1 and difficulties2 and difficulties3:
-            avg_diff1 = total_diff1 / len(difficulties1)
-            avg_diff2 = total_diff2 / len(difficulties2)
-            avg_diff3 = total_diff3 / len(difficulties3)
-            
-            print(f"\n     Comparison:")
-            print(f"       Average Difficulty (Func1): {avg_diff1:.4f}")
-            print(f"       Average Difficulty (Func2): {avg_diff2:.4f}")
-            print(f"       Average Difficulty (Func3): {avg_diff3:.4f}")
-            print(f"       Difference (Func1 vs Func2): {abs(avg_diff1 - avg_diff2):.4f}")
-            print(f"       Difference (Func1 vs Func3): {abs(avg_diff1 - avg_diff3):.4f}")
-            print(f"       Difference (Func2 vs Func3): {abs(avg_diff2 - avg_diff3):.4f}")
-
-        # Store results for final summary
-        all_results.append({
-            "user_name": user_name,
-            "word_count": len(word_list),
-            "total_diff1": total_diff1,
-            "total_diff2": total_diff2,
-            "total_diff3": total_diff3,
-            "difficulties1": difficulties1,
-            "difficulties2": difficulties2,
-            "difficulties3": difficulties3,
-        })
-
-    # Step 6: Print summary comparison
-    print("\n" + "="*80)
-    print("OVERALL SUMMARY")
-    print("="*80)
-
-    if all_results:
-        total1_sum = sum(r["total_diff1"] for r in all_results)
-        total2_sum = sum(r["total_diff2"] for r in all_results)
-        total3_sum = sum(r["total_diff3"] for r in all_results)
-        total_words = sum(r["word_count"] for r in all_results)
-
-        print(f"\nTotal Users Analyzed: {len(all_results)}")
-        print(f"Total Words Across All Users: {total_words}")
-        print(f"\nAggregate Total Difficulty:")
-        print(f"  Function 1: {total1_sum:.4f}")
-        print(f"  Function 2: {total2_sum:.4f}")
-        print(f"  Function 3: {total3_sum:.4f}")
-        print(f"  Difference (Func1 vs Func2): {abs(total1_sum - total2_sum):.4f}")
-        print(f"  Difference (Func1 vs Func3): {abs(total1_sum - total3_sum):.4f}")
-        print(f"  Difference (Func2 vs Func3): {abs(total2_sum - total3_sum):.4f}")
-
-        # Validate that all functions returned results for all users
-        assert all(r["difficulties1"] for r in all_results), "Function 1 failed for some users"
-        assert all(r["difficulties2"] for r in all_results), "Function 2 failed for some users"
-        assert all(r["difficulties3"] for r in all_results), "Function 3 failed for some users"
-        
-        print("\n✓ All tests passed!")
-    else:
-        print("\n⚠ No users with words found in this challenge")
-
-
-def test_compare_difficulty_functions_with_classic_wordlist():
-    """
-    Test all three difficulty functions using the classic.txt wordlist
-    with a sample set of words.
-    """
-    global sample_words  # Use the global variable
-
-    words_dir = os.path.join(os.path.dirname(__file__), "..", "battlewords", "words")
-    wordlist_path = os.path.join(words_dir, "classic.txt")
-    
-    if not os.path.exists(wordlist_path):
-        pytest.skip(f"classic.txt not found at {wordlist_path}")
-    
-    # Use the global sample_words if already populated, otherwise set a default
-    if not sample_words:
-        sample_words = ["ABLE", "ACID", "AREA", "ARMY", "BEAR", "BOWL", "CAVE", "COIN", "ECHO", "GOLD"]
-    
-    print("\n" + "="*80)
-    print("TESTING WITH CLASSIC.TXT WORDLIST")
-    print("="*80)
-    print(f"Sample Words: {', '.join(sample_words)}")
-    
-    # Compute difficulties
-    total_diff1, difficulties1 = compute_word_difficulties(wordlist_path, sample_words)
-    total_diff2, difficulties2 = compute_word_difficulties2(wordlist_path, sample_words)
-    total_diff3, difficulties3 = compute_word_difficulties3(wordlist_path, sample_words)
-    
-    print(f"\nFunction compute_word_difficulties Results:")
-    print(f"  Total Difficulty: {total_diff1:.4f}")
-    for word in sample_words:
-        if word in difficulties1:
-            print(f"    {word}: {difficulties1[word]:.4f}")
-    
-    print(f"\nFunction compute_word_difficulties2 Results:")
-    print(f"  Total Difficulty: {total_diff2:.4f}")
-    for word in sample_words:
-        if word in difficulties2:
-            print(f"    {word}: {difficulties2[word]:.4f}")
-    
-    print(f"\nFunction compute_word_difficulties3 Results:")
-    print(f"  Total Difficulty: {total_diff3:.4f}")
-    for word in sample_words:
-        if word in difficulties3:
-            print(f"    {word}: {difficulties3[word]:.4f}")
-    
-    # Assertions
-    assert len(difficulties1) == len(set(sample_words)), "Function 1 didn't process all words"
-    assert len(difficulties2) == len(set(sample_words)), "Function 2 didn't process all words"
-    assert len(difficulties3) == len(set(sample_words)), "Function 3 didn't process all words"
-    assert total_diff1 > 0, "Function 1 total difficulty should be positive"
-    assert total_diff2 > 0, "Function 2 total difficulty should be positive"
-    assert total_diff3 > 0, "Function 3 total difficulty should be positive"
-    
-    print("\n✓ Classic wordlist test passed!")
-
-
-if __name__ == "__main__":
-    pytest.main(["-s", "-v", __file__])

tests/test_download_game_settings.py

@@ -1,63 +0,0 @@
-# file: tests/test_download_game_settings.py
-import os
-import sys
-import pytest
-
-# Ensure the modules path is available
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
-
-from battlewords.modules.constants import HF_API_TOKEN  # <-- Import the token
-from battlewords.modules.storage import gen_full_url, _get_json_from_repo, HF_REPO_ID, SHORTENER_JSON_FILE
-
-# Ensure the token is set for Hugging Face Hub
-if HF_API_TOKEN:
-    os.environ["HF_API_TOKEN"] = HF_API_TOKEN
-
-def test_download_settings_by_short_id_handles_both(capsys):
-    # Use a fixed short id for testing
-    short_id = "hDjsB_dl"
-
-    # Step 1: Resolve short ID to full URL
-    status, full_url = gen_full_url(
-        short_url=short_id,
-        repo_id=HF_REPO_ID,
-        json_file=SHORTENER_JSON_FILE
-    )
-
-    # Failure branch: provide a helpful message and assert expected failure shape
-    if status != "success_retrieved_full" or not full_url:
-        print(
-            f"Could not resolve short id '{short_id}'. "
-            f"Status: {status}. "
-            f"Check repo '{HF_REPO_ID}' and mapping file '{SHORTENER_JSON_FILE}'."
-        )
-        captured = capsys.readouterr()
-        assert "Could not resolve short id" in captured.out
-        # Ensure failure shape is consistent
-        assert not full_url, "full_url should be empty/None on failure"
-        print("settings.json was not found or could not be resolved.")
-        return
-    else:
-        print(f"Resolved short id '{short_id}' to full URL: {full_url}")
-
-    # Success branch
-    assert status == "success_retrieved_full", f"Failed to resolve short ID: {status}"
-    assert full_url, "No full URL returned"
-
-    # Step 2: Extract file path from full URL
-    url_parts = full_url.split("/resolve/main/")
-    assert len(url_parts) == 2, f"Invalid full URL format: {full_url}"
-    file_path = url_parts[1]
-
-    # Step 3: Download and parse settings.json
-    settings = _get_json_from_repo(HF_REPO_ID, file_path, repo_type="dataset")
-    assert settings, "Failed to download or parse settings.json"
-
-    print("\nDownloaded settings.json contents:", settings)
-    # Optionally, add more assertions about the settings structure
-    assert "challenge_id" in settings
-    assert "wordlist_source" in settings
-    assert "users" in settings
-
-if __name__ == "__main__":
-    pytest.main(["-s", __file__])

tests/test_generator.py

@@ -1,29 +0,0 @@
-import unittest
-
-from battlewords.generator import generate_puzzle, validate_puzzle
-from battlewords.models import Coord
-
-
-class TestGenerator(unittest.TestCase):
-    def test_generate_valid_puzzle(self):
-        # Provide a minimal word pool for deterministic testing
-        words_by_len = {
-            4: ["TREE", "BOAT"],
-            5: ["APPLE", "RIVER"],
-            6: ["ORANGE", "PYTHON"],
-        }
-        p = generate_puzzle(grid_size=12, words_by_len=words_by_len, seed=1234)
-        validate_puzzle(p, grid_size=12)
-        # Ensure 6 words and 6 radar pulses
-        self.assertEqual(len(p.words), 6)
-        self.assertEqual(len(p.radar), 6)
-        # Ensure no overlaps
-        seen = set()
-        for w in p.words:
-            for c in w.cells:
-                self.assertNotIn(c, seen)
-                seen.add(c)
-                self.assertTrue(0 <= c.x < 12 and 0 <= c.y < 12)
-
-if __name__ == "__main__":
-    unittest.main()

tests/test_logic.py

@@ -1,55 +0,0 @@
-import unittest
-
-from battlewords.logic import build_letter_map, reveal_cell, guess_word, is_game_over
-from battlewords.models import Coord, Word, Puzzle, GameState
-
-
-class TestLogic(unittest.TestCase):
-    def make_state(self):
-        w1 = Word("TREE", Coord(0, 0), "H")
-        w2 = Word("APPLE", Coord(2, 0), "H")
-        w3 = Word("ORANGE", Coord(4, 0), "H")
-        w4 = Word("WIND", Coord(0, 6), "V")
-        w5 = Word("MOUSE", Coord(0, 8), "V")
-        w6 = Word("PYTHON", Coord(0, 10), "V")
-        p = Puzzle([w1, w2, w3, w4, w5, w6])
-        state = GameState(
-            grid_size=12,
-            puzzle=p,
-            revealed=set(),
-            guessed=set(),
-            score=0,
-            last_action="",
-            can_guess=False,
-        )
-        return state, p
-
-    def test_reveal_and_guess_gating(self):
-        state, puzzle = self.make_state()
-        letter_map = build_letter_map(puzzle)
-        # Can't guess before reveal
-        ok, pts = guess_word(state, "TREE")
-        self.assertFalse(ok)
-        self.assertEqual(pts, 0)
-        # Reveal one cell then guess
-        reveal_cell(state, letter_map, Coord(0, 0))
-        self.assertTrue(state.can_guess)
-        ok, pts = guess_word(state, "TREE")
-        self.assertTrue(ok)
-        self.assertGreater(pts, 0)
-        self.assertIn("TREE", state.guessed)
-        self.assertFalse(state.can_guess)
-
-    def test_game_over(self):
-        state, puzzle = self.make_state()
-        letter_map = build_letter_map(puzzle)
-        # Guess all words after a reveal each time
-        for w in puzzle.words:
-            reveal_cell(state, letter_map, w.start)
-            ok, _ = guess_word(state, w.text)
-            self.assertTrue(ok)
-        self.assertTrue(is_game_over(state))
-
-
-if __name__ == "__main__":
-    unittest.main()