pineapple-music/README.md

Read Before Use

Since I just need a simple player which just works right now, so I did many things in a dirty way. Don't feel so weird if you saw something I did in this project is using a bad approach.

Feature Notice

• File format support will be limited by the FFmpeg version that Qt 6 uses.
  • ...which if you use Qt's official binary, only contains the LGPLv2.1+ part. (already good enough, tho)
• No music library management support and there won't be one!
  • It'll auto-load music files in the same folder of the file that you attempted to play, so organize your music files on a folder-basis.
• Limited lyrics (.lrc) loading support:
  • Currently no .tlrc (for translated lyrics) or .rlrc (for romanized lyrics) support.
  • Multi-line lyrics and duplicated timestamps are not supported
  • Extensions (Walaoke and A2 extension) are not supported

Build

Current state, we need:

• cmake as the build system.
• qt6 with qt6-multimedia since we use it for playback.
• taglib to get the audio file properties.
• pkg-config to find the installed taglib.

Then we can build it with any proper c++ compiler like g++ or msvc.

Building it just requires normal cmake building steps:

$ cmake -Bbuild
$ cmake --build build

Help Translation!

Translate this project on Codeberg's Weblate!

About License

Pineapple Music as a whole is licensed under MIT license. Individual files may have a different, but compatible license.

All png images inside icons folder are originally created by @ShadowPower for ShadowPlayer. These images are licensed under CC0 license, grant by the original author.