|
| 1 | +# Agent Task Audit Log - Ample Linux Port |
| 2 | + |
| 3 | + |
| 4 | +## 📅 Session: 2026-03-02 (Session 3) |
| 5 | + |
| 6 | +### 🎯 Objective: Upstream Version Tracking & Documentation Maintenance |
| 7 | +Focused on updating the Linux port documentation to track MAME 0.286 and simplifying maintainability. |
| 8 | + |
| 9 | +### ✅ Key Achievements: |
| 10 | +1. **Documentation Refactoring**: |
| 11 | + * Renamed version-specific screenshot files (e.g. `screenshot-v0.28x.png` to `screenshot.png`). |
| 12 | + * Updated `README.md` and `README_tw.md` to use generic "latest version" terminology to prevent the need for manual text updates upon future Ample/MAME releases. |
| 13 | + |
| 14 | +### 🚀 Current Project Status |
| 15 | +The Linux Port documentation is updated for MAME 0.286 and future-proofed against minor version increments. |
| 16 | + |
| 17 | +--- |
| 18 | + |
| 19 | +## 📅 Session: 2026-02-17 (Session 2) |
| 20 | + |
| 21 | +### 🎯 Objective: Real-World Testing & Deployment Fix |
| 22 | +Deployed the Linux Port to an actual Linux machine for testing. Identified and fixed a critical dependency installation issue. |
| 23 | + |
| 24 | +### ✅ Key Achievements: |
| 25 | + |
| 26 | +1. **Launcher Script Fix (`AmpleLinux.sh`)**: |
| 27 | + * **Bug**: Original script used `pip3` / `pip` commands directly, which don't exist on many modern Linux distros (Debian 12+, Ubuntu 23+, Fedora 38+ enforce PEP 668). |
| 28 | + * **Fix v1**: Changed to `python3 -m pip` (the universally reliable pip invocation). |
| 29 | + * **Fix v2**: Added automatic `--break-system-packages` fallback for PEP 668-compliant systems. |
| 30 | + * **Error Messages**: Added distro-specific guidance (apt/dnf/pacman) and venv instructions in error output. |
| 31 | + |
| 32 | +2. **Git Workflow**: |
| 33 | + * Created `linux` branch from `master`. |
| 34 | + * Pushed to `origin/linux` for cross-machine testing. |
| 35 | + |
| 36 | +### 🔍 Testing Observations (Real Linux Machine): |
| 37 | +* `pip3` command was not in PATH → first fallback triggered. |
| 38 | +* `python3 -m pip` also failed (PEP 668 system Python restriction) → second fallback triggered with `--break-system-packages`. |
| 39 | +* **Conclusion**: Many modern Linux distros require either system packages (`sudo apt install python3-pyside6 python3-requests`) or a venv approach. The launcher script now documents both paths clearly. |
| 40 | + |
| 41 | +### ⚠️ Known Issue - Pending Resolution: |
| 42 | +* Systems without any pip module need manual package installation first. The script provides clear guidance but cannot auto-resolve this without `sudo`. |
| 43 | +* **Recommended solutions** (in priority order): |
| 44 | + 1. System packages: `sudo apt install python3-pyside6 python3-requests` |
| 45 | + 2. Install pip: `sudo apt install python3-pip`, then re-run script |
| 46 | + 3. Use venv: `python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt && python3 main.py` |
| 47 | + |
| 48 | +### 🚀 Current Project Status |
| 49 | +Codebase is ported and pushed to `linux` branch. Launcher script has been hardened for modern Linux distros. Awaiting successful end-to-end test with dependencies installed. |
| 50 | + |
| 51 | +--- |
| 52 | + |
| 53 | +## 📅 Session: 2026-02-16 (Session 1) |
| 54 | + |
| 55 | +### 🎯 Objective: Linux Port Creation |
| 56 | +Ported AmpleWin (Windows) to Linux, following the original author's suggestion (ksherlock/ample#45) that Linux support would be easy to add. |
| 57 | + |
| 58 | +### ✅ Key Achievements: |
| 59 | + |
| 60 | +1. **Codebase Porting (from AmpleWin)**: |
| 61 | + * **Zero-Modification Files**: `data_manager.py`, `rom_manager.py`, `mame_launcher.py`, `requirements.txt` — copied directly, no changes needed. |
| 62 | + * **Simplified `mame_downloader.py`**: Removed `MameDownloadWorker` entirely (Linux users install MAME via their package manager). Kept `VgmModDownloadWorker` with Linux adaptations (7z via PATH, no `.exe` suffix, helpful `p7zip` install instructions). |
| 63 | + * **`main.py` (~20 changes)**: Comprehensive platform adaptation: |
| 64 | + - Replaced `winreg` theme detection with `gsettings` (GNOME 42+ `color-scheme`) and KDE (`kdeglobals`) dark mode detection. |
| 65 | + - Replaced all `os.startfile()` calls with `xdg-open` via a helper function `_xdg_open()`. |
| 66 | + - Removed all `.exe` suffixes from MAME binary references (`mame.exe` → `mame`, `mame-vgm.exe` → `mame-vgm`). |
| 67 | + - Enhanced `check_for_mame()` to search system paths (`/usr/bin/mame`, `/usr/games/mame`, `/usr/local/bin/mame`) and use `which mame`. |
| 68 | + - Replaced `Download MAME` button with package manager guidance text. |
| 69 | + - Updated `shlex.split()` from `posix=False` (Windows) to `posix=True` (Linux). |
| 70 | + - Updated file browser filter from `*.exe` to `All Files (*)`. |
| 71 | + - Changed window title and help URL. |
| 72 | + |
| 73 | +2. **Launcher Script**: |
| 74 | + * Created `AmpleLinux.sh` as equivalent of `AmpleWin.bat`. |
| 75 | + * Includes Python 3 detection, pip dependency installation, and helpful error messages with distro-specific commands. |
| 76 | + |
| 77 | +3. **Documentation**: |
| 78 | + * Created dual-language READMEs (`README.md` English, `README_tw.md` Traditional Chinese). |
| 79 | + * Includes installation guide for all major distros (Ubuntu, Fedora, Arch, Flatpak). |
| 80 | + * Troubleshooting section for PySide6, MAME detection, and theme issues. |
| 81 | + |
| 82 | +### 🔍 Design Decisions: |
| 83 | + |
| 84 | +1. **Separate Directory (not shared codebase)**: Chose to create `AmpleLinux/` as a separate directory rather than refactoring `AmpleWin/` into a shared codebase. This maintains the project convention where each platform gets its own additive subdirectory, minimizing risk to the stable Windows port. |
| 85 | + |
| 86 | +2. **No MAME Auto-Download**: Following the original author's guidance ("let the user download it themselves"), Linux users install MAME via their system package manager. This is the Linux cultural norm and avoids complex binary distribution issues. |
| 87 | + |
| 88 | +3. **GNOME + KDE Theme Detection**: Implemented multi-strategy dark mode detection covering GNOME 42+ `color-scheme`, older GNOME `gtk-theme`, and KDE `kdeglobals`, with Qt palette as ultimate fallback. |
| 89 | + |
| 90 | +### 🚀 Current Project Status |
| 91 | +The Linux Port is functionally complete. All Windows-specific code has been adapted, and the application should work on major Linux distributions with GNOME or KDE desktops. |
| 92 | + |
| 93 | +--- |
| 94 | + |
| 95 | +## Handover Notes for Future Agents |
| 96 | + |
| 97 | +### 1. Platform Differences from AmpleWin |
| 98 | +* **No `winreg`**: Theme detection uses `gsettings` and KDE config file parsing. |
| 99 | +* **No `os.startfile()`**: Uses `xdg-open` via the `_xdg_open()` helper function. |
| 100 | +* **No `.exe` suffixes**: All binary references use bare names (`mame`, `mame-vgm`). |
| 101 | +* **No MAME auto-download**: Users install via package manager. Settings dialog shows guidance. |
| 102 | +* **`shlex.split(posix=True)`**: Linux uses POSIX-mode shell parsing (no special Windows path handling). |
| 103 | +* **MAME detection**: Checks `PATH` via `which`, plus standard Linux paths (`/usr/bin`, `/usr/games`, `/usr/local/bin`). |
| 104 | + |
| 105 | +### 2. Deployment (CRITICAL) |
| 106 | +* **PEP 668 Era**: Modern Linux distros (Debian 12+, Ubuntu 23.04+, Fedora 38+) block global pip installs. The launcher script handles this with `--break-system-packages` fallback. |
| 107 | +* **Recommended Install Methods** (in priority order): |
| 108 | + 1. System packages: `sudo apt install python3-pyside6 python3-requests mame` |
| 109 | + 2. venv: `python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt` |
| 110 | + 3. pip with override: `python3 -m pip install -r requirements.txt --break-system-packages` |
| 111 | +* **Never use `pip3` or `pip` directly** in scripts — always use `python3 -m pip` for reliability. |
| 112 | + |
| 113 | +### 3. Known Mantras (inherited from AmpleWin) |
| 114 | +* **Visual Parity is King**: Every margin, font size, and color was cross-referenced with macOS. |
| 115 | +* **Authorship**: This Linux Port is based on the AmpleWin collaboration between **anomixer** and **Antigravity**. |
| 116 | + |
| 117 | +--- |
| 118 | + |
| 119 | +## 📅 Session: 2026-02-17 (Session 2) |
| 120 | + |
| 121 | +### 🎯 Objective: First-Run Experience, Build System & Polish |
| 122 | + |
| 123 | +### ✅ Key Changes: |
| 124 | + |
| 125 | +1. **Launcher Architecture (`AmpleLinux.sh`)**: |
| 126 | + * **Refactored to venv**: Switched from system-level `apt` dependencies to a strictly isolated `python3 -m venv` approach. |
| 127 | + * **Automated Setup**: Script now auto-creates `.venv`, installs `python3-venv` (if missing), and pip installs `requirements.txt`. |
| 128 | + * **Distro Agnostic**: Only depends on `python3-full` and `libxcb-cursor*` (apt) for the base interpreter; all libraries (PySide6) are pulled via pip. |
| 129 | + * **ALSA Fix**: Added auto-detection of `/proc/asound` and `usermod -a -G audio` fix for permission issues. |
| 130 | + |
| 131 | +2. **User Experience Enhancements (`main.py`)**: |
| 132 | + * **Ubuntu Snap Integration**: If MAME is missing on Ubuntu, offers `sudo snap install mame` with a non-blocking `QProgressDialog`. |
| 133 | + * **Configuration Fix**: `ensure_mame_ini` now runs `mame -cc` inside `AmpleLinux/mame` to keep config portable. |
| 134 | + * **Path Precision**: `update_command_line` now resolves absolute paths for `-inipath` and `-rompath` (e.g., `/home/user/...`). |
| 135 | + * **BGFX Cleanup**: Removed Windows-only Direct3D options. |
| 136 | + * **UI Polish**: "Generate VGM" now shows a "Feature not implemented" popup. |
| 137 | + |
| 138 | +3. **Build System (New)**: |
| 139 | + * **`make_icon.py`**: Created Linux-specific icon generator (produces standard PNG sizes: 16x16 to 512x512). |
| 140 | + * **`build_elf.sh`**: Created PyInstaller build script that uses a temporary venv to bypass PEP 668 restrictions and produce a standalone ELF binary in `dist/`. |
| 141 | + |
| 142 | +### 🔍 Technical Decisions: |
| 143 | +* **PySide6 via pip**: Moved away from `python3-pyside2` (apt) because the codebase is written for PySide6. Using venv + pip ensures version consistency and avoids the "externally-managed-environment" error on modern distros. |
| 144 | +* **MAME Snap**: For Ubuntu users, Snap is the most reliable way to get a recent MAME version without PPA complexity. |
0 commit comments