KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #typescript #codex #claude-code #mcp #rust #deepseek-harness #ai-agent #cli

doki

★ 190 Open GitHub ↗

An Android library that displays information from dontkillmyapp.com to users in a clean and presentable manner.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Doki 
[![Freenode IRC channel.](https://img.shields.io/badge/freenode-%23%23doubledotlabs-brightgreen.svg)](https://webchat.freenode.net/?channels=%23%23doubledotlabs&uio=MTY9dHJ1ZSY5PXRydWUmMTE9MjE1e1)
[![Twitter account.](https://img.shields.io/badge/twitter-%40doubledotlabs-blue.svg?color=43b4f9&logo=twitter)](https://twitter.com/doubledotlabs)
![API](https://img.shields.io/badge/API-16%2B-34bf49.svg)
[![Build Status](https://travis-ci.org/DoubleDotLabs/doki.svg?branch=master)](https://travis-ci.org/DoubleDotLabs/doki)
[![JitPack](https://jitpack.io/v/dev.doubledot/doki.svg)](https://jitpack.io/#dev.doubledot/doki)
=====

**A Don't Kill My App Library**

The aim of [dontkillmyapp.com](https://dontkillmyapp.com/problem) is to create
a collection of guides and information to help users and developers
troubleshoot issues on their devices related to background tasks being killed
unnecessarily by the Android system. This library displays relevant
information from this site to the user of an affected application, and attempts
to walk users through the process of solving the problem themselves, hopefully
reducing the amount of time that developers have to spend providing support as
a result of these issues.

## Previews

| Default Activity | Activity w Custom Theme | Dialog                                  | Customized Doki View |
|------------------|-------------------------|-----------------------------------------|----------------------|
| ![The default doki activity.](https://github.com/DoubleDotLabs/doki/raw/main/art/1.png) | ![Doki in a custom-themed activity.](https://github.com/DoubleDotLabs/doki/raw/main/art/2.png) | ![Doki inside of a dialog.](https://github.com/DoubleDotLabs/doki/raw/main/art/3.png) | ![Doki with nice, fun, shiny colours.](https://github.com/DoubleDotLabs/doki/raw/main/art/4.png) |

For testing and experimentation purposes, a sample apk can be downloaded [here](../../releases).

# How to use it

Doki is available via JitPack, so getting it as simple as adding it as a
dependency, like this:

1. Add JitPack repository to your root `build.gradle` file

```gradle
allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}
```

2. Add the dependency in your project `build.gradle` file

```gradle
dependencies {
    implementation('dev.doubledot.doki:library:0.0.1@aar') {
        transitive = true
    }
}
```

### DokiActivity

The `DokiActivity` provides you with a default uncustomized implementation
of the Doki API that is quick and easy to set up and use. Simply call
`DokiActivity.start(...)` to open it.

<details open>
<summary>Kotlin</summary>
<p>

```kotlin
DokiActivity.start(context = ...)
```

</p>
</details>

```java
DokiActivity.start(context);
```

</p>
</details>

Alternatively, you can use `DokiActivity.newIntent(...)` to create an
Intent to open it.

### DokiContentView

`DokiContentView` is the custom view that `DokiActivity` is based on. Implementing
it allows for greater customization and use in more complex scenarios.

In the layout you want to include our custom view, just add it like this:

```xml
<dev.doubledot.doki.views.DokiContentView
        xmlns:android="http://schemas.android.com/apk/res/android"
        android:id="@+id/doki_content"
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>
```

In order to fetch content from the [Don't Kill My App website](https://dontkillmyapp.com/),
you must call `loadContent()` on the view.

<details open>
<summary>Kotlin</summary>
<p>

```kotlin
val doki : DokiContentView? = findViewById(R.id.doki_content)
doki?.loadContent()
```

</p>
</details>

```java
DokiContentView doki = findViewById(R.id.doki_content);
if (doki != null) doki.loadContent();
```

</p>
</details>

## Customization

If you are using the `DokiContentView`, you can customize it by setting custom attributes.
Please check [this file](https://github.com/doubledotlabs/doki/blob/c18efeb07292e191e39e3e62d589009474919c56/sample/src/main/res/layout/activity_doki_custom.xml#L9-L26)
which implements every option available.

For custom fonts and text styles, you can override the following styles:

```xml
<style name="Doki.Custom.Headline" parent="Doki.Headline"/>
<style name="Doki.Custom.Overline" parent="Doki.Overline"/>
<style name="Doki.Custom.Button" parent="Doki.Button"/>
```

And add the following attributes as you wish and with the values you want:

```xml
<item name="fontFamily">sans-serif</item>
<item name="android:fontFamily">sans-serif</item>
<item name="android:textStyle">bold</item>
<item name="android:textAllCaps">false</item>
<item name="android:textSize">16sp</item>
<item name="android:letterSpacing">0.1</item>
```

**Note: don't change the parent styles, just add the attributes you want to modify**

# Contributors :sparkles:

* [Jahir Fiquitiva](https://jahir.xyz/) ([GitHub](https://github.com/jahirfiquitiva/), [Twitter](https://twitter.com/jahirfiquitiva)) :man_technologist:
* [James Fenn](https://jfenn.me/) ([GitHub](https://github.com/fennifith/), [Twitter](https://twitter.com/fennifith)) :man_technologist:
* [Eduardo Pratti](https://pratti.design) ([Twitter](https://twitter.com/edpratti)) :art:

# Dependencies

Thank you to everyone that helped to make this project possible!

- [urbandroid-team/dont-kill-my-app](https://github.com/urbandroid-team/dont-kill-my-app)
- [noties/Markwon](https://github.com/noties/Markwon)
- [square/retrofit](https://github.com/square/retrofit)
- [square/okhttp](https://github.com/square/okhttp)
- [ReactiveX/RxAndroid](https://github.com/ReactiveX/RxAndroid)
- [afollestad/material-dialogs](https://github.com/afollestad/material-dialogs)

# License

```
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

doki

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README