= Phocid
:note-caption: ℹ️
:warning-caption: ⚠️

image:metadata/en-US/images/icon.png[Icon,64px]
image:https://img.shields.io/f-droid/v/org.sunsetware.phocid[F-Droid Version,link=https://f-droid.org/en/packages/org.sunsetware.phocid/]
image:https://img.shields.io/badge/official-website-blue[Official website,link=https://sunsetware.org/phocid]
image:https://img.shields.io/badge/works_on-my_machine-yellow[Works on my machine]
image:https://img.shields.io/github/license/tjysunset/phocid[License]

NOTE: https://github.com/TJYSunset/Phocid/issues/185[Phocid is currently in maintenance mode.]

image:metadata/en-US/images/phoneScreenshots/00-screenshot-home-tracks.png[Screenshot,15%]
image:metadata/en-US/images/phoneScreenshots/01-screenshot-home-albums.png[Screenshot,15%]
image:metadata/en-US/images/phoneScreenshots/02-screenshot-home-folders.png[Screenshot,15%]
image:metadata/en-US/images/phoneScreenshots/03-screenshot-search.png[Screenshot,15%]
image:metadata/en-US/images/phoneScreenshots/04-screenshot-player.png[Screenshot,15%]

A modern offline music player with familiar designs for Android 11+.

This project aims to be a replacement with personal tweaks for the now-defunct https://github.com/kabouzeid/Phonograph[Phonograph] music player, but has no connections with it.

== Help & FAQ

Please refer to https://sunsetware.org/phocid/help/[the help page on the website.]

If your problem is not covered by this page, you can create an https://github.com/TJYSunset/Phocid/issues[issue] or https://github.com/TJYSunset/Phocid/discussions[discussion] depending on the severity.

== Features

* Familiar user experience
* Better metadata support; Namely, multiple artists.
* Better sorting when your music library differs from your system language
* Regex-based blocklist
* Playback speed and pitch control
* More lyrics styles
* Optional less-vibrant colors
* Brand new design based on Material Design 3

== Missing features that are intentionally left out

* Tag editing
+
The scene of audio file tagging is a disaster.
The best metadata support library I could find is still buggy; I recommend using well-known dedicated software for this task.
* Deleting files
* Anything that requires an internet connection
* Lock screen
* Playback statistics

== Reporting a crash

A crash report should have been saved to `Android/data/org.sunsetware.phocid/files/crash.txt` in your external storage.
Please https://github.com/TJYSunset/Phocid/issues[create an issue] with the report attached.

NOTE: Depending on your system, you might need to connect your phone to a computer to see this file.

WARNING: This file contains uncensored logs.
Although it should not contain sensitive information, you are responsible for checking whether this holds true.

== Building

Remember to clone the submodule with `git clone --recurse-submodules`.

== Contributing

Please ask first if you want to work on big code changes.
Instead of directly contributing code to Phocid, it would be great if you can help with big upstream issues first, like https://github.com/androidx/media/issues/81. (Please let me know if you have successfully closed those!)

If you would like to help with translations, please use https://sunsetware.org/phocid/translate/[the translation editor] and follow the instructions. Alternatively, you can use your preferred translation tool, set it up for Android + https://unicode-org.github.io/icu/userguide/format_parse/messages/[ICU MessageFormat 1.0], then submit a pull request.
Please don't submit machine translations or AI hallucinations.

I don't accept donations.

== Credits

=== Translators

* de: https://github.com/Omega-3-4-5[Omega-3-4-5], https://github.com/phoenixr-codes[phoenixr-codes]
* es: https://github.com/AlejandroMoc[AlejandroMoc]
* fr: https://github.com/HermitCyclop[HermitCyclop]
* pt-BR: https://github.com/MateusRodCosta[MateusRodCosta]
* ru: https://github.com/yurtpage[yurtpage]
* zh-Hant: https://github.com/kisaragi-hiu[kisaragi-hiu]

== License

=== App icon artwork

....
This work by tjysunset is licensed under CC BY-SA 4.0. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/
....

=== Code

....
Phocid
Copyright (C) tjysunset <tjysunset@outlook.com>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
....