Update audio handling and UI improvements

Version 0.2.10 introduces several enhancements and fixes:
- Updated software version in `__init__.py` to 0.2.10.
- Enhanced README.md with sections on "Assets Setup" and "Sound Asset Generation."
- Refactored `audio.py` to organize music and sound effects into separate directories.
- Improved UI in `ui.py` with better text input color and scoreboard adjustments.
- Modified sound management to play "congratulations" music at game end.
- Added metadata to audio files like `correct_guess.mp3` and `hit.mp3`.
- Refactored code with a new `hidden_word_display` function in `logic.py`.
- Made minor bug fixes and UI adjustments for better game experience.
- Updated `incorrect_guess.mp3` and `miss.mp3` with new metadata and audio content.
- Added significant binary data to `background.mp3`, re-encoded with LAME3.100.

README.md

@@ -106,6 +106,18 @@ docker run -p 8501:8501 battlewords
 
 ## Changelog
 
+-0.2.11
+  - update timer to be live during gameplay, but reset with each action
+  - compact design
+
+-0.2.10
+  - reduce sonar graphic size
+  - update music and special effects file locations
+  - remove some music and sound effects
+  - change Guess Text input color
+  - incorrect guess UI update
+  - scoreboard update
+
 -0.2.9
   - fix sonar grid alignment issue on some browsers
   - When all letters of a word are revealed, it is automatically marked as found.
@@ -240,3 +252,86 @@ Spaces can be embedded in other sites using an `<iframe>`:
 
 For full configuration options, see [Spaces Config Reference](https://huggingface.co/docs/hub/spaces-config-reference) and [Streamlit SDK Guide](https://huggingface.co/docs/hub/spaces-sdks-streamlit).
 
+# Assets Setup
+
+To fully experience BattleWords, especially the audio elements, ensure you set up the following assets:
+
+- Place your background music `.mp3` files in `battlewords/assets/audio/music/` to enable music.
+- Place your sound effect files (`.mp3` or `.wav`) in `battlewords/assets/audio/effects/` for sound effects.
+
+Refer to the documentation for guidance on compatible audio formats and common troubleshooting tips.
+
+# Sound Asset Generation
+
+To generate and save custom sound effects for BattleWords, you can use the `generate_sound_effect` function.
+
+## Function: `generate_sound_effect`
+
+```python
+def generate_sound_effect(effect: str, save_to_assets: bool = False, use_api: str = "huggingface") -> str:
+    """
+    Generate a sound effect and save it as a file.
+
+    Parameters:
+    - `effect`: Name of the effect to generate.
+    - `save_to_assets`: If `True`, saves the effect to the assets directory; 
+      if `False`, saves to a temporary location. Default is `False`.
+    - `use_api`: API to use for generation. Options are "huggingface" or "replicate". Default is "huggingface".
+
+    Returns:
+    - File path to the saved sound effect.
+    """
+
+    # ... [sound generation code] ...
+
+    if save_to_assets:
+        # Save to effects directory
+        assets_dir = os.path.join(os.path.dirname(__file__), "assets", "audio", "effects")
+        os.makedirs(assets_dir, exist_ok=True)
+        filename = f"{effect}.wav"
+        path = os.path.join(assets_dir, filename)
+        with open(path, "wb") as f:
+            f.write(audio_bytes)
+        print(f"  Saved to: {path}")
+    else:
+        # Save to temporary file
+        with tempfile.NamedTemporaryFile(suffix=".wav", delete=False) as tmpfile:
+            tmpfile.write(audio_bytes)
+            path = tmpfile.name
+            print(f"  Saved to: {path}")
+
+    return path
+```
+
+## Parameters
+
+- `effect`: The name of the sound effect you want to generate (e.g., "explosion", "powerup").
+- `save_to_assets` (optional): Set to `True` to save the generated sound effect to the game's assets directory. If `False`, the effect is saved to a temporary location. Default is `False`.
+- `use_api` (optional): The API to use for generating the sound. Options are `"huggingface"` or `"replicate"`. Default is `"huggingface"`.
+
+## Returns
+
+- The function returns the file path to the saved sound effect, whether it's in the assets directory or a temporary location.
+
+## Usage Example
+
+To generate a sound effect and save it to the assets directory:
+
+```python
+generate_sound_effect("your_effect_name", save_to_assets=True)
+```
+
+To generate a sound effect and keep it in a temporary location:
+
+```python
+temp_path = generate_sound_effect("your_effect_name", save_to_assets=False)
+```
+
+## Note
+
+Ensure you have the necessary permissions and API access (if required) to use the sound generation service. Generated sounds are subject to the terms of use of the respective API.
+
+For any issues or enhancements, please refer to the project documentation or contact the project maintainer.
+
+Happy gaming and sound designing!
+

battlewords/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "0.2.9"
+__version__ = "0.2.10"
 __all__ = ["models", "generator", "logic", "ui"]

battlewords/assets/audio/congratulations.mp3

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:da52c73b00948b8c7fe0197f62a57af5ee439b5b1acef31c7add3868d23af437
-size 74446

battlewords/assets/audio/game-10.mp3

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:b588435cd1bd29ab5876c9737ad217899db0f46c5370f80e29c8f11cdb1c92bc
-size 1201966

battlewords/assets/audio/game-11.mp3

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:8efa6142714a74c57c8b8bbe77c19db3a2635e07ada9d59ec30b9215553b1442
-size 2209458

battlewords/assets/audio/game-2.mp3

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:348786a20423e706a4966155f966d78e6e8bf5608ffdc6bb673269f03da81810
-size 1782099

battlewords/assets/audio/game-3.mp3

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:233b892a347322b8071a2daada0c092000d11ce85abb7a0c2df24ddcdc4f6271
-size 1201972

battlewords/assets/audio/game-8.mp3

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:edb317a64cd37bf8b5fefe9efb0553d302ed9b0570a5eba3ad01a67077a9f49a
-size 2161810

battlewords/audio.py

@@ -2,15 +2,17 @@ import os
 from typing import Optional
 import streamlit as st
 
-def _get_audio_dir() -> str:
-    return os.path.join(os.path.dirname(__file__), "assets", "audio")
+def _get_music_dir() -> str:
+    return os.path.join(os.path.dirname(__file__), "assets", "audio", "music")
+
+def _get_effects_dir() -> str:
+    return os.path.join(os.path.dirname(__file__), "assets", "audio", "effects")
 
 def get_audio_tracks() -> list[tuple[str, str]]:
-    """Return list of (label, absolute_path) for .mp3 files in assets/audio."""
-    audio_dir = _get_audio_dir()
+    """Return list of (label, absolute_path) for .mp3 files in assets/audio/music."""
+    audio_dir = _get_music_dir()
     if not os.path.isdir(audio_dir):
         return []
-    # Only include .mp3 files, ignore .wav files
     tracks = []
     for fname in os.listdir(audio_dir):
         if fname.lower().endswith('.mp3'):
@@ -145,7 +147,7 @@ def get_sound_effect_files() -> dict[str, str]:
     Return dictionary of sound effect name -> absolute path.
     Prefers .mp3 files; falls back to .wav if no .mp3 is found.
     """
-    audio_dir = _get_audio_dir()
+    audio_dir = _get_effects_dir()
     if not os.path.isdir(audio_dir):
         return {}
 

battlewords/logic.py

@@ -143,6 +143,9 @@ def compute_tier(score: int) -> str:
         return "Good"
     return "Keep practicing"
 
+def hidden_word_display(letters_display: int) -> str:
+    """Return a string of '?' of length letters_display."""
+    return "?" * letters_display
 
 def auto_mark_completed_words(state: GameState) -> bool:
     """Automatically mark words as found when all their letters are revealed.

battlewords/ui.py

@@ -14,12 +14,12 @@ import time
 from datetime import datetime
 
 from .generator import generate_puzzle, sort_word_file
-from .logic import build_letter_map, reveal_cell, guess_word, is_game_over, compute_tier, auto_mark_completed_words
+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  # use loader directly
 from .version_info import versions_html  # version info footer
 from .audio import (
-    _get_audio_dir,
+    _get_music_dir,
     get_audio_tracks,
     _load_audio_data_url,
     _mount_background_audio,
@@ -221,6 +221,11 @@ def inject_styles() -> None:
              position: absolute;     
              max-width:100%;
           }
+          .stImage { max-width:300px;}
+          #text_input_2 {
+          background-color:#fff;
+          color:#000;
+          caret-color:#333;}
 
          @media (min-width:720px) {
           .st-emotion-cache-wp60of {
@@ -411,11 +416,10 @@ def _render_sidebar():
         st.header("Audio")
         tracks = get_audio_tracks()
         # Show how many audio files were found
-        st.caption(f"{len(tracks)} audio file{'s' if len(tracks) != 1 else ''} found in battlewords/assets/audio")
+        st.caption(f"{len(tracks)} audio file{'s' if len(tracks) != 1 else ''} found in battlewords/assets/audio/music")
 
         if "music_enabled" not in st.session_state:
-            # disabled by default
-            st.session_state.music_enabled = False #if tracks else True
+            st.session_state.music_enabled = False
         if "music_volume" not in st.session_state:
             st.session_state.music_volume = 15
 
@@ -457,7 +461,7 @@ def _render_sidebar():
             src_url = _load_audio_data_url(selected_path) if enabled else None
             _mount_background_audio(enabled, src_url, (st.session_state.music_volume or 0) / 100)
         else:
-            st.caption("Place .mp3 files in battlewords/assets/audio to enable music.")
+            st.caption("Place .mp3 files in battlewords/assets/audio/music to enable music.")
             _mount_background_audio(False, None, 0.0)
 
         _inject_audio_control_sync()
@@ -667,7 +671,7 @@ def _render_radar(puzzle: Puzzle, size: int, r_max: float = 0.8, max_frames: int
     if cached_path and os.path.exists(cached_path) and cached_sig == gif_signature:
         with open(cached_path, "rb") as f:
             gif_bytes = f.read()
-        st.image(gif_bytes, use_container_width=True)
+        st.image(gif_bytes, width='stretch',)
         plt.close(fig)
         return
 
@@ -680,7 +684,7 @@ def _render_radar(puzzle: Puzzle, size: int, r_max: float = 0.8, max_frames: int
         gif_bytes = tmpfile.read()
         st.session_state.radar_gif_path = tmpfile.name  # Save path for reuse
         st.session_state.radar_gif_signature = gif_signature  # Save signature to detect changes
-    st.image(gif_bytes, use_container_width=True)
+    st.image(gif_bytes, width='stretch')
 
 def _render_grid(state: GameState, letter_map, show_grid_ticks: bool = True):
     size = state.grid_size
@@ -892,13 +896,13 @@ def _render_guess_form(state: GameState):
         """
         <style>
         .bw-incorrect-guesses {
-            font-size: 0.85rem;
-            color: #ff9999;
-            margin-top: 4px;
-            padding: 4px 8px;
-            background: rgba(255, 255, 255, 0.05);
-            border-radius: 4px;
-            font-style: italic;
+            font-size: 0.7rem;
+            color: #fff;
+            margin-top: -10px;
+            # padding: 2px 4px;
+            # background: rgba(255, 255, 255, 0.05);
+            # border-radius: 10px;
+            # font-style: italic;
         }
         </style>
         """,
@@ -913,8 +917,7 @@ def _render_guess_form(state: GameState):
                 value="", 
                 max_chars=10, 
                 width=200, 
-                key="guess_input",
-                help=tooltip_text  # Use Streamlit's built-in help parameter for tooltip
+                key="guess_input"                
             )
         with col2:
             submitted = st.form_submit_button("OK", disabled=not state.can_guess, width=100, key="guess_submit")
@@ -922,7 +925,7 @@ def _render_guess_form(state: GameState):
         # Show compact list below input if setting is enabled
         if st.session_state.get("show_incorrect_guesses", False) and recent_incorrect:
             st.markdown(
-                f'<div class="bw-incorrect-guesses">Recent: {", ".join(recent_incorrect)}</div>',
+                f'<div class="bw-incorrect-guesses" title="{tooltip_text}">Recent incorrect guesses:</div>',
                 unsafe_allow_html=True,
             )
         
@@ -957,8 +960,8 @@ def _render_score_panel(state: GameState):
 
     for w in state.puzzle.words:
         pts = state.points_by_word.get(w.text, 0)
-        if pts > 0 or state.game_mode == "too easy":
-            letters_display = len(w.text)
+        letters_display = len(w.text)
+        if pts > 0 or state.game_mode == "too easy":            
             # Extra = total points for the word minus its length (bonus earned)
             extra_pts = max(0, pts - letters_display)
             row_html = (
@@ -969,6 +972,16 @@ def _render_score_panel(state: GameState):
                 "</tr>"
             )
             rows_html.append(row_html)
+        else:
+            # Hide unguessed words in classic mode
+            row_html = (
+                "<tr>"
+                f"<td class=\"blue-background \">{hidden_word_display(letters_display)}</td>"
+                f"<td class=\"blue-background \">{letters_display}</td>"
+                f"<td class=\"blue-background \">?</td>"
+                "</tr>"
+            )
+            rows_html.append(row_html)
 
     # Timer calculation (initial render value)
     now = datetime.now()
@@ -1048,8 +1061,16 @@ def _render_score_panel(state: GameState):
 # -------------------- Game Over Dialog --------------------
 
 def _game_over_content(state: GameState) -> None:
-    # Play congratulations sound when game ends
-    play_sound_effect("congratulations", volume=0.7)
+    # Play congratulations music (not sound effect) as background
+    music_dir = _get_music_dir()
+    congrats_music_path = os.path.join(music_dir, "congratulations.mp3")
+    if os.path.exists(congrats_music_path):
+        src_url = _load_audio_data_url(congrats_music_path)
+        # Play at full volume (or use previous music_volume setting)
+        _mount_background_audio(True, src_url, (st.session_state.get("music_volume", 100)) / 100)
+    else:
+        # Fallback: keep previous music or silence
+        _mount_background_audio(False, None, 0.0)
 
     # Set end_time if not already set
     if state.end_time is None: