Thanks for your interest in contributing to Finamp! This document goes over how to get started on Finamp development, and other ways to contribute.
Finamp is a fairly standard Flutter app, so all you have to do is install Flutter. Once Flutter is installed, you should be able to run Finamp on emulators/real devices.
To build release APKs, you need to set up a signing key for Android. To get that set up, follow this guide from the Flutter documentation. Note that if you have Finamp installed already, your phone may panic because the key is different.
Because Dart doesn't support macros and stuff, a few dependencies rely on code generation which must be run manually. These dependencies are:
- Hive - the database that Finamp uses for storing all data
json_serializable- For deserialising JSON into classes- Chopper - For talking to Jellyfin over HTTP
- This layer (
lib/services/jellyfin_api.dart) is not used by the app directly. The user-facing API is located atlib/services/jellyfin_api_helper.dart.
- This layer (
To rebuild these files, run dart run build_runner build --delete-conflicting-outputs. This must be done when:
- Modifying a class that is returned by Jellyfin (such as the classes in
lib/models/jellyfin_models.dart) - Adding fields to a database class (annotated with
@HiveType)
If you don't rebuild generated files, you will encounter:
- Settings not persisting
- Hive errors on startup
- Missing data when converting JSON to classes
As said earlier, Finamp uses Hive for all data storage needs. If you're doing work that involves data storage, I recommend you read the Hive docs. Please ensure that your changes work when upgrading Finamp from the current release to your changes, as not handling upgrades will cause the app to crash. When downgrading, you will have to wipe your app data if any changes were made to Hive.
When creating new types, note that you'll also have to register an adapter in main.dart. After code generation, there should be a class called [YourType]Adapter, which you can initialise in setupHive.
The biggest main piece of work being done on Finamp at the moment is the redesign. The relevant issue can be found here. The redesign branch has diverged a lot from main, but I try to keep it updated. If you're struggling to decide what to work on, the redesign is a good place to look :)
Finamp uses Weblate to manage translations: https://hosted.weblate.org/engage/finamp/
Feel free to add new languages if yours isn't there yet. If you have any questions, such as the context of a string, you can ask in the Translation Discussions.