https://github.com/vixalien/muzika

Elegant music streaming app
https://github.com/vixalien/muzika

gnome gtk gtk4 libadwaita music youtube-music ytm

Last synced: about 2 months ago
JSON representation

Elegant music streaming app

• Host: GitHub
• URL: https://github.com/vixalien/muzika
• Owner: vixalien
• License: gpl-3.0
• Created: 2023-05-24T08:02:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-13T19:32:15.000Z (5 months ago)
• Last Synced: 2024-04-15T16:08:06.648Z (5 months ago)
• Topics: gnome, gtk, gtk4, libadwaita, music, youtube-music, ytm
• Language: TypeScript
• Homepage:
• Size: 12.6 MB
• Stars: 198
• Watchers: 7
• Forks: 12
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: COPYING

Awesome Lists containing this project

• awesome-gtk - Muzika - Music player with customizable home screen and Google Music integration `#gjs` `#libadwaita`. (Audio / Audio Players)

README

        
# Muzika

Muzika is an elegant music streaming app.

![Muzika home page](data/resources/screenshots/home.png)

![Muzika playing "My Queen is Angela Davis"](data/resources/screenshots/playing.png)

> Note: This is a work in progress. The app is not yet ready for production.

## Features

- Personalized home screen

- Search for songs, albums, artists, radios and playlists

- Login with Google and access your playlists and more from your library

- Play personalized radios & mixes

- View song lyrics & related information

- Browse artists, albums and playlists etc.

## Installation

### Using the latest Nightly Flatpak

You can download the [latest Nightly flatpak](https://vixalien.github.io/muzika/muzika.flatpakref).

### From source

Dependencies:

- GNOME Builder

1. Clone the repository

```bash

git clone https://github.com/vixalien/muzika.git --recurse-submodules

```

2. Open the project in GNOME Builder and use "Build" to build the project.

> Note: Using Meson and Ninja directly is no longer supported because Muzika

> uses the latest (unreleased) libadwaita components.

## Navigation

Muzika has a robust navigator that allows you to navigate through different

pages by using muzika URIs. Some of them are documented below.

The muzika URI has the form `muzika:endpoint:data`. URIs can also have query

parameters. For example, `muzika:library?view=grid` will open the library page

with the grid view.

You can navigate to a muzika URI by directly typing it in the search bar and

muzika will visit that page directly instead of searching it.

You can also navigate to a given endpoint by triggering the navigator action

manually:

1. Open the GTK inspector by pressing `Ctrl+Shift+I`.

2. Click on the `Actions` tab on the right.

3. Look for the action named `navigator.visit` and type in your URI in the

   `Parameter` field, then click `Activate`.

### Endpoints

A list of all endpoints are [here](src/pages.ts).

- `muzika:home` - Home page

- `muzika:playlist:` - Playlist page. eg:

  `muzika:playlist:PL4fGSI1pDJn6puJdseH2Rt9sMvt9E2M4i`/

- `muzika:album:` - Album page.

- `muzika:artist:` - Artist or Channel page.

- `search:` - Search. Note that query must be URL encoded. eg:

  `search:hello%20world` searches for `hello world`.

- `muzika:library` - Library.

More endpoints will be added as Muzika supports more features.