Thank you for your interest in Ghosten Player! This guide will help you understand how to contribute to the repository.
Warning
The following documentation only covers key points in the development process.
Install the Flutter SDK from the download page.
The Flutter SDK version must match the one used in the GitHub Action build; otherwise, the build may fail.
Refer to:
If you are new to Flutter, detailed installation instructions can be found in the official documentation.
The app runs only on arm devices (including emulators) with Android version 6+.
Use flutter run --flavor=mobile for the mobile version and flutter run --flavor=tv --target=lib/main_tv.dart for the TV version.
Currently, mock data is not supported. You can add your own data by referring to the Wiki.
If you are using Windows as your development machine, it is recommended to create a WebDAV server using the built-in Internet Information Services (IIS).
Then create a test directory inside it to simulate a real-world usage environment.
Reference documentation
If you use themoviedb for scraping, you need to prepare an api_key and assign it as the default value for the following variable. It can also be passed via environment variables.
See the reference documentation for examples. If not provided, themoviedb scraping will be disabled.
Line 6 in 576d6c2
Currently, only front-end contributions are supported, including UI, interaction, internationalization, etc. Player-related code has been moved to this repository.
Currently, only Simplified Chinese and English are supported. The English translation may not be very accurate. If you are a native English speaker or proficient in English, please help us improve the translations.
If you are a speaker of other languages, you can add new language translations.
Internationalization documentation: https://docs.flutter.dev/ui/internationalization
The internationalization files are located in the lib/l10n directory.