Skip to content

Building TetherFi

pyamsoft edited this page Dec 8, 2024 · 1 revision

Building TetherFi

Generally speaking, you are on your own when attempting to build TetherFi. I will try to help you with compilation issues, but I am not IT tech support and won't be able to troubleshoot every machine.

My Build Setup

TetherFi is coded and built on my own machine, which runs ArchLinux. I develop using the Android Studio flatpak.

Compiling

Compilation should work as follows. Once you have cloned the project, you will be unable to sync Android Studio initially. This is because TetherFi currently uses a custom fork of Ktor due to this open feature request.

You will first need to build the pyamsoft custom fork of ktor. More detailed instructions for doing this can be found here. Note that building KTOR can potentially take a long time (hours), and so you may instead wish to edit the code and remove the couple of lines using the fork specific feature.

Once the ktor fork is built, you can then sync and assemble the TetherFi project like you would normally for any other project.

Ktor Fork

The Ktor fork is only needed currently because Ktor upstream does not support the TetherFi feature for a preferred network for socket communication. If and when upstream does support this, the fork can be removed and TetherFi should be able to be built as a normal project.

Build Support

There is zero support for custom builds or tool chains. I am only one person and it is just not feasible to support every configuration under the sun, sorry.