UI Clean Up, Support Free Models & Addition of Developer Tools

.gitignore

@@ -172,9 +172,26 @@ memory/ai-2/*
 logs/*
 !logs/.gitkeep
 videos/*
-shitpostbench_evaluation.md
-shitpostbench.py
-reduce_html_size.py
+models_cache.json
+.claude/
+settings/splitter_state.json
 
-# Benchmark reports (local only)
-shitpostbench_reports/
+# BackroomsBench evaluation reports (generated outputs, except leaderboard)
+backroomsbench_reports/*
+!backroomsbench_reports/.gitkeep
+!backroomsbench_reports/LEADERBOARD.md
+!backroomsbench_reports/leaderboard.json
+
+# Output conversation files (timestamped)
+outputs/conversation_*.html
+outputs/conversation_full.html
+
+# Keep the outputs folder structure
+!outputs/.gitkeep
+
+# Root-level generated HTML files (but allow docs/*.html for GitHub Pages)
+/*.html
+
+# Temporary diff files
+diff_*.txt
+DIFF_*.md

README.txt → README.md

@@ -30,6 +30,7 @@ While great for AI shitposting, this is easy to customize for interesting experi
 ## Features
 
 - Multi-model AI conversations with support for:
+
   - Claude (Anthropic) - all versions
   - GPT (OpenAI)
   - Grok (xAI)
@@ -39,6 +40,7 @@ While great for AI shitposting, this is easy to customize for interesting experi
   - Anything on OpenRouter - if it's not listed, add it in config
 
 - AI Agent Commands:
+
   - `!add_ai "Model Name" "persona"` - invite another AI to the conversation (max 5)
   - `!image "description"` - generate an image (Gemini 3 Pro)
   - `!video "description"` - generate a video (Sora 2) [currently disabled in scenarios]
@@ -74,37 +76,49 @@ OPENAI_API_KEY=your_openai_api_key            # Optional - only needed for Sora
 ```
 
 Get your keys:
+
 - OpenRouter: https://openrouter.ai/
 - OpenAI (for Sora): https://platform.openai.com/
 
 ## Installation
 
 1. Clone the repository:
+
 ```bash
 git clone [repository-url]
 cd liminal_backrooms
 ```
 
 2. Install Poetry if you haven't already:
+
 ```bash
 curl -sSL https://install.python-poetry.org | python3 -
 ```
 
 3. Install dependencies using Poetry:
+
 ```bash
 poetry install
 ```
 
-4. Create your `.env` file with API keys (see above)
+4. Set up pre-commit hooks (for contributors):
+
+```bash
+poetry run pre-commit install
+```
+
+5. Create your `.env` file with API keys (see above)
 
 ## Usage
 
 1. Start the application:
+
 ```bash
 poetry run python main.py
 ```
 
 2. GUI Controls:
+
    - Mode Selection: Choose between AI-AI conversation or Human-AI interaction
    - Iterations: Set number of conversation turns (1-100)
    - AI Model Selection: Choose models for each AI slot
@@ -119,13 +133,24 @@ poetry run python main.py
 ## Configuration
 
 Application settings in `config.py`:
+
 - Runtime settings (turn delay, etc.)
 - Available AI models in `AI_MODELS` dictionary
 - Scenario prompts in `SYSTEM_PROMPT_PAIRS` dictionary
 
+### Developer Tools
+
+For debugging the GUI, set `DEVELOPER_TOOLS = True` in `config.py`. This enables:
+
+- **F12**: Toggle debug inspector panel
+- **Ctrl+Shift+C**: Pick and inspect any UI element
+
+Keep this `False` for normal usage.
+
 ### Adding New Models
 
 Add entries to `AI_MODELS` in config.py:
+
 ```python
 "Model Display Name": "openrouter/model-id",
 ```
@@ -143,6 +168,7 @@ To enable video generation:
 3. Videos save to `videos/` folder
 
 Environment variables (optional):
+
 ```env
 SORA_SECONDS=12        # clip duration (4, 8, 10, 12)
 SORA_SIZE=1280x720     # resolution
@@ -153,11 +179,13 @@ SORA_SIZE=1280x720     # resolution
 ## Troubleshooting
 
 1. API Issues:
+
    - Check API key validity in `.env`
    - Verify you have credits on OpenRouter
    - Check console for error messages
 
 2. GUI Issues:
+
    - Ensure PyQt6 is installed (handled by Poetry install)
    - Check Python version compatibility
 
@@ -168,10 +196,17 @@ SORA_SIZE=1280x720     # resolution
 ## Contributing
 
 1. Fork the repository
-2. Create a feature branch
-3. Commit your changes
-4. Push to the branch
-5. Create a Pull Request
+2. Clone and install dependencies:
+   ```bash
+   poetry install
+   poetry run pre-commit install
+   ```
+3. Create a feature branch
+4. Make your changes
+5. Commit (pre-commit hooks will run automatically)
+6. Push and create a Pull Request
+
+**Note**: The pre-commit hook will block commits if `DEVELOPER_TOOLS = True` in config.py. Make sure to set it back to `False` before committing.
 
 ## License