Skip to content

Latest commit

 

History

History
71 lines (38 loc) · 4.24 KB

README.md

File metadata and controls

71 lines (38 loc) · 4.24 KB
Raw

BiglyBT-Android

API License

BiglyBT for Android is an ad-free, fully featured open source bittorrent client and remote control optimized for phones, tablets, Chromebooks, and Android TVs.

You can find our app on Google Play. Here's a link that maybe Google Search will like 😉 BiglyBT: Torrent Downloading Client for Android

You can also get it F-Droid:

Get it on F-Droid

This is fork of Vuze Remote for Android, which stopped development in early 2017.

Contributing

Spread the Word

As a user, the most important thing you can do to help us is to spread the word of BiglyBT. BiglyBT is fairly unknown. Mentioning BiglyBT on your favorite tracker site, blog, wiki, facebook, social media sites, and to friends would help us a lot. Don't get discouraged.

Other people will have different client preferences than you, and they will often feel attacked when someone talks about a client that isn't theirs. Try to keep discussions positive and informative! We want to co-exist with all clients, since all clients can help share.

Translations

Our translations for BiglyBT for Android are typically behind compared to BiglyBT core translations. Our Android project only has a couple of dozen languages, compared to the 40+ in BiglyBT core, and most of them are terribly incomplete.

Preferably, we'd love it if your native language wasn't English, however, anyone fluent in another language is very much appreciated.

To join in on the translations, please visit our BiglyBT-Android CrowdIn project. Translations are open to anyone with a CrowdIn account. If you would like to translate into a language that isn't listed, please let us know by creating a GitHub Issue and we will add it!

Code Style

In Android Studio, we use the plugin Eclipse Code Formatter to format the code, with the scheme in BiglyBT/PreferencesJavaCodeStyleFormatter.xml

Building

Initial Steps

  1. Import into Android Studio (v3.5+) as New Project

  2. From the command line at the root of the project directory (where this README.md is), run the following:

    chmod +x updatePlugins.sh
./updatePlugins.sh 2.2.0.3

    updatePlugins will copy the required plugin JARs and assets into your local source tree. The script requires bash, zip, unzip, and wget (all available on Windows with cygwin).

    Note: The release branches contain the full source for the core and plugins, instead of as JARs in BiglyBT/libs/. Using jars during development reduces load on Android Studio and reminds us they are libraries that shouldn't be modified.

    Without this step, starting the torrenting service on the Android device will result in the error "preinstallPlugins: java.io.FileNotFoundException: plugins.zip" and the frontend will not be able to connect to the server.

  3. (Optional) Choose the correct build variant to compile with using Build->Select Build Variant. The most usable variant is coreFlavorFossFlavorDebug.

  4. File->Sync Project with Gradle Files. This resolves the Error: Please select Android SDK error, as well as ensuring all jars in the libs/ folder are processed.

Updating Source

No special steps are needed to update the android source. A simple VCS->Update Project... will suffice.

You can occasionaly check for submodule updates with the git submodule update in the Terminal window (Newer Android Studio versions may do this automatically with Update Project...)

To get fresh plugin jars, you can run ./updatePlugins.sh <version> with the latest beta version number of BiglyBT which is listed at the top of https://github.com/BiglySoftware/BiglyBT/blob/master/ChangeLog.txt