Quick Lofi

Play lofi music and other sounds, locally or online, on your GNOME desktop with just a click!

Demo

quick-lofi-demo.webm

Features

• Play lofi and any other sound with one click
• Global keyboard shortcuts for quick control
• Volume control directly from pop-up menu
• Drag and drop to rearrange radio stations
• Adjustable pop-up height

Dependencies

This extension requires mpv. Install it using your package manager:

# Fedora
sudo dnf install mpv

# Debian/Ubuntu
sudo apt install mpv

# Arch
sudo pacman -S mpv

# openSUSE
sudo zypper install mpv

Installation

Via EGO

1. Install from the extension page using the browser integration or the Extension Manager.

From the release .zip

1. Download quicklofi@eucaue.zip from the releases page.

2. Run in the same folder:

   gnome-extensions install --force quicklofi@eucaue.zip

3. Log out and back in.

Manual installation (stable)

You're installing the latest release, which may not work on older GNOME versions, check the release notes. Requires Node and NPM.

1. Clone the repository:

   git clone https://github.com/EuCaue/gnome-shell-extension-quick-lofi.git

2. Install dependencies:

   npm install

3. Build and install:

   npm run install:prod

4. Log out and back in.

From the develop branch (latest, may be unstable)

Use this if you want the newest features before they hit a release. Requires Node and NPM.

⚠️ The develop branch targets the latest GNOME version and your current version may not be supported.

1. Clone the repository and switch to the develop branch:

   git clone https://github.com/EuCaue/gnome-shell-extension-quick-lofi.git
   cd gnome-shell-extension-quick-lofi
   git checkout develop

2. Install dependencies:

   npm install

3. Build and install:

   npm run install:prod

4. Log out and back in.

---

Development

Requires Node and NPM.

Pull requests should be opened against the develop branch.

Set up a local environment to work on the extension:

1. Clone the repository:

   git clone https://github.com/EuCaue/gnome-shell-extension-quick-lofi.git
   cd gnome-shell-extension-quick-lofi

2. Switch to the develop branch:

   git checkout develop

3. Install dependencies:

   npm install

4. Build and run the extension in a nested GNOME Wayland session:

   npm run run:dev

---

Troubleshooting

If something isn't working as expected, enabling debug logs helps a lot when diagnosing problems. Please follow the steps below before opening an issue.

Enable debug logging

Debug logging can be enabled either from the extension preferences or via the CLI.

From the UI:

• Open Quick Lofi Preferences
• Go to the Interface tab
• Enable Debug logging

From the CLI:

gsettings --schemadir "$HOME/.local/share/gnome-shell/extensions/quick-lofi@eucaue/schemas" set "org.gnome.shell.extensions.quick-lofi" "enable-debug" true

Collect logs

When debug logging is enabled, Quick Lofi writes logs to:

/tmp/quick-lofi-$USER.log

To view the logs:

cat /tmp/quick-lofi-$USER.log

To copy the logs to your clipboard:

cat /tmp/quick-lofi-$USER.log | wl-copy

If the file is empty or missing, make sure debug logging is enabled and reproduce the issue once more.

Open an issue

When opening a new issue, please include:

• A clear description of the problem
• Steps to reproduce
• Your GNOME version
• Your Quick Lofi version
• The debug logs collected above (paste them or attach the file)

Open an issue here

---

Contributing

Contributions are always welcome! 💡

1. Fork the repository and create a new branch based on develop for your changes.
2. Make your improvements whether it's fixing a bug, improving code, or adding a feature.
3. Commit and push your changes to your branch.
4. Open a pull request against the develop branch with a short description of what you've done.
5. If you find any bugs or have ideas, feel free to open an issue anytime!

---

Made with ❤️ by EuCaue