Welcome to the KeinPlan Documentation!

This book serves as the documentation for usage and contribution to KeinPlan, an alternative Android client for replacement table access.

It is split into two parts:

• The User Guide, which outlines application concept, configuration options, recommended usage and troubleshooting options.

• The Development Guide, which highlights technical details, architecture, how to build the app and how to contribute.

This documentation itself can be found in the docs/ subdirectory of the project, and it allows contributions as every part of the project does. If you find any mistakes or want to add information, feel free to open an issue or a pull request!

Roadmap

The following is a preliminary roadmap for new features and releases. Bugfixes, stability and security have priority and will be brought as minor releases. The timestaps are not fixed; while they serve as orientation and aims, they are not to be asserted.

• Between releases:

  • Completion of this documentation
  • Linting and static analysis via ktlint/detekt
  • Corresponding documentation/CI for replace
  • Releases on more platforms (Flathub, AUR, Homebrew…)

• Release 26.12.1

  • Personal notification support (possibly via on-demand polling)
  • Screen swipe carousel

Install the app!

Android

For the Android app, there are more or less four ways of installation:

• Using the F-Droid Store (recommended for regular users, you may need to install F-Droid itself first)
• Using auto-updating releases via Obtainium
• Downloading the APK from Codeberg Releases
• Building the application yourself

Note that with the latter two methods, you won’t get automatic updates for your application, so you would need to keep an eye out for new releases!

Because of attempts of Google to lock down alternative installation methods and to avoid entering into direct competition with DSBmobile, we do not publish to the Play Store and have no plans to do so.

Desktop

Currently, the only way to install the Desktop application pre-compiled is via the Codeberg Releases. The application is capable of running on Linux, macOS and Windows; if your OS is not in the releases, you may need to build it yourself, as the respective operating system is not available to me.

The desktop build can be considered an alpha-release, has limited features and may be instable. Feel free to open an issue if the program crashes or shows any other unexpected behavior!

We are planning to release the application in an auto-updating manner, e.g. via the AUR or Homebrew, once it can be considered stable.

iOS

Although KeinPlan can be compiled for iOS, we do not currently release to iOS or the App Store.

If there are any similar-looking applications the App Store or the Play Store, we are not associated with them. Please notify me if an application imitating KeinPlan appears on these storefronts.