a4ankur/butter-android

Butter for Android

Allow any Android user to watch movies easily streaming from torrents, without any particular knowledge.

Visit the project's website at http://butterproject.org.

Community

Keep track of Butter development and community activity.

Follow Butter on Twitter, Facebook and Google+.
Join in discussions on the Butter Forum

Roadmap

pre 1.0.0

0.4.0 - Migrating app to MVP arhitecture
0.5.0 - Refactor media providers
0.6.0 - Update video player and resolve media streaming issues
0.7.0 - Refactor updater to work on p2p protocol
0.8.0 - Updating connect SDK
0.9.0 - Cleaning up project (resources, proguard, ...)
1.0.0 - Making app stable for release

pos 1.0.0

Make media providers available through Content Providers.
Make desktop JS media providers available on Android.
Support multiple audio sources.

Getting Involved

Want to report a bug, request a feature, contribute or translate Butter? Check out our in-depth guide to Contributing to Butter.

Build Instructions

The gradle build system will fetch all dependencies and generate files you need to build the project. You first need to generate the local.properties (replace YOUR_SDK_DIR by your actual android sdk dir) file:

$ echo "sdk.dir=YOUR_SDK_DIR" > local.properties

You can now sync, build and install the project:

$ ./gradlew assembleDebug # assemble the debug .apk
$ ./gradlew installDebug  # install the debug .apk if you have an
                          # emulator or an Android device connected

You can use Android Studio by it as existing project.

Directory structure

`|-- base                            # base module (contains providers and streamer)
 |    |-- build.gradle               # base build script
 |    `-- src
 |          |-- main
 |                |-- assets         # base module assets
 |                |-- java           # base module java code
 |                `-- res            # base module resources
`|-- mobile                          # mobile module (smartphone/tablet application)
 |    |-- build.gradle               # mobile build script
 |    `-- src
 |          |-- main
 |                |-- java           # mobile module java code
 |                `-- res            # mobile module resources
`|-- tv                              # tv module (Android TV application)
 |    |-- build.gradle               # tv build script
 |    `-- src
 |          |-- main
 |                |-- java           # tv module java code
 |                `-- res            # tv module resources
`|-- vlc                             # vlc module (VLC mediaplayer library)
 |    |-- build.gradle               # vlc module build script
 |    `-- src
 |          |-- main
 |                |-- jniLibs        # native LibVLC libraries
 |                |-- java           # LibVLC Java code
`|-- connectsdk                      # connectsdk module
      |-- build.gradle               # connectsdk build script
      `-- src
      |     |-- java                 # connectsdk module java code
      `-- core
      |     |-- src                  # connectsdk module core java code
      `-- modules
            |-- google_cast
                  |-- src            # connectsdk module google cast java code
            |-- firetv
                  |-- src            # connectsdk module google cast java code

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Butter will be maintained according to the Semantic Versioning guidelines as much as possible.

Beta versions

Beta releases will be numbered with the following format:

0.<major>.<minor>-<patch>

Stable versions

Releases will be numbered with the following format:

<major>.<minor>.<patch>

Constructed with the following guidelines:

A new major release indicates a large change where backwards compatibility is broken.
A new minor release indicates a normal change that maintains backwards compatibility.
A new patch release indicates a bugfix or small change which does not affect compatibility.

License

If you distribute a copy or make a fork of the project, you have to credit this project as source.

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 http://www.gnu.org/licenses/.

Note: some dependencies are external libraries, which might be covered by a different license compatible with the GPLv3. They are mentioned in NOTICE.md.

a4ankur / butter-android