bttv-android

A mod of the Twitch Android Mobile App adding BetterTTV and FrankerFaceZ emotes

Install

1. Scim through this guide on how to enable third party app istallations
2. Go to the latest releasepage and download the .apk file of the mod. It periodically checks for new releases so you only have to download it once from there.

Build it yourself

This patch is meant to be applied to version 10.7.0 of the official twitch app
Make sure you use this version before you create an issue!

Easy way: Docker

Prerequisites:

Docker

How to:

1. Clone this repo

2. Get the Twitch App's apk files (e.g from [here][evozi], or [here][apkmirror])

   Please make sure you get it from a non-shady source!

   If you have downloaded a single .apk file, name it twitch.apk

   If you have downloaded a bundle of .apk files put them in a .zip archive and name it twitch.zip

   Note: Apkmirror publishes bundles as .apkm files, those are just zip files, so rename them to twitch.zip

3. Run the builder:

   docker run --rm -ti \
      -v path/to/twitch.apk:/usr/build/twitch.apk \
      -v /path/to/dist:/usr/build/dist \
      -v path/to/monke.patch:/usr/build/monke.patch \
      -v /path/to/mod:/usr/build/mod \
      ghcr.io/bttv-android/builder
   

   If you are in the same directory as the apk file you can copy and paste:

   docker run --rm -ti \
      -v $(pwd)/twitch.apk:/usr/build/twitch.apk \
      -v $(pwd)/dist:/usr/build/dist \
      -v $(pwd)/monke.patch:/usr/build/monke.patch \
      -v $(pwd)/mod:/usr/build/mod \
      ghcr.io/bttv-android/builder
   

4. The dist directory will contain the patched apk file!

5. Transfer to device and install apk

6. Remove the builder again: docker rmi ghcr.io/bttv-android/builder

Hard way

Prerequisites:

How to:

If you get stuck at any point, just remove the disass dir and try again

0. Download and install prerequisites
1. Get the Twitch App's apk files (e.g from [here][evozi]), drop them zipped in this directory and call it "twitch.zip"

   Please make sure you get it from a non-shady source!
   If you have adb installed follow [this guide][adb-apk] (Method 3)

2. The ./initworkspace script will disassemble the apks, build the sources, apply monkey patches and build the new apk for you
3. Transfer to device and install apk

   (Adb installed and device connected? Try the : ./install script)

Overview

bttv/
├─ initworkspace - used to set up everything
├─ buildsource - used to build the java sources
├─ build - re-assembles the 'extracted' dir
├─ decompile - you need JADX to use this
├─ install - install the result of build on a device (using adb)
├─ monke.patch - contains monkey patches
├─ genmonke - script that generates the monke.patch based on extracted (more below)
├─ extracted/ - renamed from disass
│  ├─ AndroidManifest.xml
│  ├─ res/
│  ├─ smali_classes0-10/ - contains disassembled app + bttv code
│  ├─ dist/
│  │  ├─ twitch.apk - the final app
├─ mod/        - java sources for patches
│  ├─ app/     - sources for the mod
|  ├─ twitch/  - stubs so we can call twitch's classes

genmonke

During initialization the disass / extraced dir is initialized with an empty git repo.
Right after the disassemblement the first commit is made and tagged "base".
This is used to generate the patch file.
monke.patch is thus the result of a diff between master and base.

Only source changes

You need to nothing else, you can commit your code and start a pull request!

Monkey patch changes

Run ./genmonke <dir> before you make a commit.

GitHub

https://github.com/bttv-android/bttv