Skip to content

android

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

android

README.md

FrostWire for Android

A file sharing client, media player and simple file manager for your Android devices.

FrostWire for Android lets you search and download files from the BitTorrent network and several popular cloud video services.

All the BitTorrent functionality is done using FrostWire's jlibtorrent library, a set of high level libtorrent wrappers.

The FrostWire team is an active contributor to libtorrent and jlibtorrent always tries to stay on par with the latest libtorrent release.

Coding guidelines

  • Keep it simple.

  • Do not repeat yourself. Re-use your own code and our code. It'll be faster to code, and easier to maintain.

  • If you want to help, Issue tracker is a good place to take a look at.

  • Try to follow our coding style and formatting before submitting a patch.

  • All pull requests should come from a feature branch created on your git fork. We'll review your code and will only merge it to the master branch if it doesn't break the build. If you can include tests for your pull request you get extra bonus points ;)

  • When you submit a pull request, try to explain what issue you're fixing in detail and how you're fixing it in detail, so it's easier for us to read your patches. If it's too hard to explain what you're doing, you're probably making things more complex than they already are. Look and test your code well before submitting patches.

  • We prefer well named methods and code re-usability than a lot of comments. Code should be self-explanatory.

Becoming a core collaborator with direct commit access to the upstream repository will only happen after we have received lots of great patches and we get to know you better.

Build Requirements

Pre-requisites:

  • JDK 17 or later (OpenJDK or Oracle JDK)
  • Android SDK - Minimum API 26 (Android 8.0 Oreo), Target API 34 (Android 14)
  • Android NDK (for native library compilation if building from source)
  • Gradle (included with the gradlew Gradle Wrapper script)
  • Git to clone and version control the project

Make sure your JAVA_HOME and PATH environment variables are set correctly.

Example on a Linux/Mac system's .bashrc or .zshrc file:

export JAVA_HOME=/path/to/jdk17
export PATH=${PATH}:${JAVA_HOME}/bin

For Android SDK, you can download it via Android Studio or as standalone tools.

We recommend using Android Studio as your development environment (it handles most configuration automatically).

Submitting Pull Requests

  • Fork the project.

  • No matter how small your change will be, create a feature branch for it.

  • Make sure the name of your feature branch describes what you're trying to fix. If you don't know what to name it and there's an issue created for it, name your branch issue-233 (where 233 would be the number of the issue you're fixing).

  • If your branch has taken a while to be accepted for merging into master, it's very likely that the master branch will have moved forward while you work. In this case, make sure to sync your master.

git checkout master
git pull upstream master

and then rebase your branch to bring it up to speed so it can be merged properly:

git checkout my-branch
git rebase master

as you do this you may have to fix any possible conflicts, just follow the instruction git gives you if this is your first time.

  • Make sure to squash any cosmetic commits into the body of your work so that we don't pollute the history and you don't get more bitcoins than you should from the rest of the collaborators for things like fixing a typo you just introduced on your branch.

Build instructions

Android Studio

  1. Make sure you have Android Studio properly installed.
  2. Open the project in Android Studio.
  3. Wait for gradle sync and indices to update.
  4. Should work out of the box.

Command line

To build a debug APK:

./gradlew assembleDebug

The built APK will be located at build/outputs/apk/debug/.

To run tests:

./gradlew test

To clean build artifacts:

./gradlew clean

To install and run on a connected device or emulator:

./gradlew installDebug

For more build options:

./gradlew tasks

On Windows, use gradlew.bat instead of ./gradlew.

Happy coding!

Troubleshooting

Build fails with "SDK location not found"

Make sure you have Android SDK properly installed and the ANDROID_SDK_ROOT or ANDROID_HOME environment variable set:

export ANDROID_SDK_ROOT=/path/to/android/sdk
# or
export ANDROID_HOME=/path/to/android/sdk

Gradle sync issues in Android Studio

  1. Go to File → Invalidate Caches / Restart
  2. Select Invalidate and Restart
  3. Wait for the project to re-index

Out of memory errors during build

Increase Gradle heap size in gradle.properties:

org.gradle.jvmargs=-Xmx2560m -XX:+UseParallelGC --enable-native-access=ALL-UNNAMED

Python/Chaquo build errors

FrostWire Android uses Chaquo for Python integration. Ensure you have Python 3 installed on your system.

Code Organization

Location Contains
src/main/java/com/frostwire/ Core FrostWire functionality (search, downloads, media management).
src/main/java/com/limegroup/ Legacy code from LimeWire origins.
res/ Android resources (layouts, strings, drawables, etc).
apollo/ Apollo music player library integration.
build.gradle Project dependencies and build configuration.
proguard-rules.pro ProGuard/R8 obfuscation rules for release builds.

Download

Latest binaries | Previous versions (SourceForge)

Downloading FrostWire does not constitute permission or a license for obtaining or distributing unauthorized files. It is illegal for you to distribute copyrighted files without permission.

If you want to know about legal content you can download and distribute legally please visit FrostClick, VODO, ClearBits.net and Creative Commons

License

See COPYING for the license. Frostwire for Android is offered under the GNU General Public License Version 3 (GPL 3.0).