Albumus Audio Compiler - GUI Guide
The Albumus GUI (gui.py) provides a simple, interactive interface to select project folders and run audio-related tasks such as compiling albums and clearing output. It offers visual feedback, customizable settings, and a categorized task panel.
π Launching the GUI
To run the GUI:
python gui.py
Make sure the following requirements are met:
- Python 3.9+
customtkinterinstalled- A valid
config/settings.jsonexists (will be created if missing)
πΌ GUI Features
Project Directory Management
Recent Directory Dropdown:
- Select from previously used project directories.
- Automatically filters invalid paths.
Browse Button (π):
- Opens a file dialog to select a new project directory.
- Updates the dropdown and config settings automatically.
Task Buttons
Tasks are grouped by category and displayed in horizontal scrollable sections. Each button:
- Executes a predefined Python command.
- Shows a tooltip describing what it does.
- Logs output in the GUI and writes it to disk.
Default Tasks:
| Task | Description |
|---|---|
compile_audio | Compiles input files into tagged, multi-format albums |
clear_output | Deletes the project's output directory (out/) |
Status Panel
- Located at the bottom of the interface
- Displays real-time task results or error messages
- Color-coded: Green = success, Red = error
π§ Configuration
The GUI references:
config/settings.jsonto track the current working projectAutomatically updates:
dir: currently selected projectdir_recent: history of recent projectsdir_recent_max: how many recent paths to remember
If invalid directories are detected on launch, they are removed from the dropdown list automatically.
π§ͺ Example Workflow
Launch the app:
python gui.pyUse the dropdown or browse button to choose a valid project folder.
Click
compile_audioto process the files in thein/directory.View results in the status panel and check the
_log/directory for full logs.Use
clear_outputto delete generated output (out/folder) for a clean rebuild.
π Troubleshooting
| Problem | Fix / Explanation |
|---|---|
| "Config file not found" | Ensure config.json exists in your project |
| "Invalid directory selected" | Must include config.json and an in/ folder |
| No output generated | Make sure metadata JSON and audio files exist |
| GUI doesnβt launch | Confirm customtkinter is installed properly |
π Log Files
All actions are logged in the _log/ directory:
gui.logcompile_audio.logclear_output.log
These include timestamped entries, error reports, and command details.
β Summary
The GUI offers an easy-to-use interface for managing audio compilation projects without needing to use the terminal. It provides structure validation, task execution, logging, and feedback for a smooth user experience.