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](https://doc.qt.io/qt-6/qtmultimedia-attribution-ffmpeg.html).
  - ...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:

```shell
$ cmake -Bbuild
$ cmake --build build
```

## Help Translation!

[Translate this project on Codeberg's Weblate!](https://translate.codeberg.org/projects/pineapple-apps/pineapple-music/)

## 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](https://github.com/ShadowPower/) for [ShadowPlayer](https://github.com/ShadowPower/ShadowPlayer). These images are licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0/legalcode) license, grant by the original author.
chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00			`## Read Before Use`
misc fixes for linux 2020-04-07 12:58:08 +08:00
feat: get audio file properties from taglib 2020-04-19 18:22:21 +08:00			`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.`
misc fixes for linux 2020-04-07 12:58:08 +08:00
chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00			`### Feature Notice`

			`- File format support will be limited by the [FFmpeg version that Qt 6 uses](https://doc.qt.io/qt-6/qtmultimedia-attribution-ffmpeg.html).`
			`- ...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!`
feat: basic lyrics support 2024-09-20 20:59:40 +08:00			`- 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.`
chore: bump CI Qt version, update README.md 2024-09-27 23:21:57 +08:00			- 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`
chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00
feat: get audio file properties from taglib 2020-04-19 18:22:21 +08:00			`## Build`

			`Current state, we need:`

			- `cmake` as the build system.
chore: require Qt 6.5.1 Related: QTBUG-112707 2023-05-27 16:36:51 +08:00			- `qt6` with `qt6-multimedia` since we use it for playback.
feat: get audio file properties from taglib 2020-04-19 18:22:21 +08:00			- `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.`

chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00			`Building it just requires normal cmake building steps:`
feat: get audio file properties from taglib 2020-04-19 18:22:21 +08:00
chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00			```shell
			`$ cmake -Bbuild`
			`$ cmake --build build`
			```
feat: get audio file properties from taglib 2020-04-19 18:22:21 +08:00
Update README.md 2020-06-08 23:56:05 +08:00			`## Help Translation!`

chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00			`[Translate this project on Codeberg's Weblate!](https://translate.codeberg.org/projects/pineapple-apps/pineapple-music/)`
Update README.md 2020-06-08 23:56:05 +08:00
feat: album cover support copy-paste from the old SP codebase 2020-04-09 18:12:35 +08:00			`## About License`

chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00			`Pineapple Music as a whole is licensed under MIT license. Individual files may have a different, but compatible license.`
feat: album cover support copy-paste from the old SP codebase 2020-04-09 18:12:35 +08:00
chore: license cleanup, other tweaks 2024-09-08 00:34:45 +08:00			All png images inside `icons` folder are originally created by [@ShadowPower](https://github.com/ShadowPower/) for [ShadowPlayer](https://github.com/ShadowPower/ShadowPlayer). These images are licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0/legalcode) license, grant by the original author.