Skip to content

Commit e7af2f8

Browse files
authored
Merge pull request #40 from Manabu-GT/ms-v1.1.4
prep for v1.1.4 release
2 parents 8c2e2bf + 5d62f22 commit e7af2f8

File tree

3 files changed

+31
-30
lines changed

3 files changed

+31
-30
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Change Log
22

3+
## Version 1.1.4 *(2025-10-27)*
4+
5+
* **Build & toolchain** – Migrated the entire project to Gradle Kotlin DSL with a shared `libs.versions.toml`, upgraded the wrapper/AGP stack (Gradle 8.13, AGP 8.13.0).
6+
* **Android platform updates** – Raised `minSdk` to 26 / `targetSdk` to 36, migrated dependencies to AndroidX, and cleaned up manifest/service initialization (DebugOverlay now installs only in the app’s main process and drops stale permission checks).
7+
* **CPU/FPS modules** – Fixed CPU usage/frequency collectors to operate correctly on API 26+ and tidied related overlays/resources.
8+
39
## Version 1.1.3 *(2017-09-24)*
410

511
* Add a NetStatsModule as an extension module

README.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
DebugOverlay-Android
22
===========
3-
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-DebugOverlay--Android-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/5516)
43
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.ms-square/debugoverlay/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.ms-square/debugoverlay)
5-
[![API 16+](https://img.shields.io/badge/API-16%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=16)
4+
[![API 26+](https://img.shields.io/badge/API-26%2B-brightgreen.svg?style=flat)](https://developer.android.com/tools/releases/platforms#8.0)
65
[![License](https://img.shields.io/badge/license-Apache%202-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
76

87
**DebugOverlay** is an Android library that allows developers to easily add custom overlay window/view for debugging purpose.
@@ -15,7 +14,7 @@ This library is fully customizable in terms of what you can show on the overlay.
1514

1615
Requirements
1716
-------------
18-
API Level 16 (Android 4.1) and above.
17+
API Level 26 (Android 8.0) and above.
1918

2019
Setup
2120
------
@@ -24,25 +23,25 @@ so you just need to add the followings to your ***build.gradle*** file:
2423

2524
```groovy
2625
dependencies {
27-
debugCompile 'com.ms-square:debugoverlay:1.1.3'
28-
releaseCompile 'com.ms-square:debugoverlay-no-op:1.1.3'
29-
testCompile 'com.ms-square:debugoverlay-no-op:1.1.3'
26+
debugImplementation 'com.ms-square:debugoverlay:1.1.4'
27+
releaseImplementation 'com.ms-square:debugoverlay-no-op:1.1.4'
28+
testImplementation 'com.ms-square:debugoverlay-no-op:1.1.4'
3029
}
3130
```
3231

33-
Please note that `com.ms-square:debugoverlay:1.1.3` will add `android.permission.SYSTEM_ALERT_WINDOW` to your app.
34-
Threfore, you should avoid to use that dependency for your release build.
32+
Please note that `com.ms-square:debugoverlay:1.1.4` will add `android.permission.SYSTEM_ALERT_WINDOW` to your app.
33+
Therefore, you should avoid to use that dependency for your release build if your app itself doesn't require it.
3534

3635
FYI, the following table describes the total number of method/field references in this library's release aar.
3736
This data is acquired by using [Dexcount Gradle Plugin](https://github.com/KeepSafe/dexcount-gradle-plugin).
3837

39-
| library | methods | fields |
40-
|:------------- |:-------------|:-------------|
41-
|com.ms-square:debugoverlay:1.1.3|566|252|
42-
|com.ms-square:debugoverlay-no-op:1.1.3|141|37|
38+
| library | methods | fields |
39+
|:---------------------------------------|:--------|:-------|
40+
| com.ms-square:debugoverlay:1.1.4 | 572 | 248 |
41+
| com.ms-square:debugoverlay-no-op:1.1.4 | 142 | 31 |
4342

4443
Due to the extensibility of this library, no-op version unfortunately has more than a few methods.
45-
If you want to eliminate such method count in your release build, consider having separate `Application` class only for your debug build which uses this library and just specify `debugCompile 'com.ms-square:debugoverlay:1.1.3'` in the dependencies section of build.gradle.
44+
If you want to eliminate such method count in your release build, consider having separate `Application` class only for your debug build which uses this library and just specify `debugImplementation 'com.ms-square:debugoverlay:1.1.4'` in the dependencies section of build.gradle.
4645

4746
Usage
4847
------
@@ -61,7 +60,7 @@ public class ExampleApplication extends Application {
6160
}
6261
}
6362
```
64-
It will show a debug overlay on system layer with the follwing three default modules just like the gif animation image displayed on this README.
63+
It will show a debug overlay on system layer with the following three default modules just like the gif animation image displayed on this README.
6564

6665
- [CpuUsageModule](#cpuusagemodule) - will not be shown on Android O and above
6766
- [MemInfoModule](#meminfomodule)
@@ -107,7 +106,7 @@ new DebugOverlay.Builder(this)
107106
>Alpha value used for text on the overlay. Default is `1f`(fully opaque).
108107
109108
* allowSystemLayer - [boolean]
110-
>If true, it adds the overlay window on Android's system window layer; in Android 7.1.1 and after, it will ask you for the overlay permission by taking you to the Android's settings screen when you first set up. If set to false, it will automatically add the overlay on each application window. In most cases, you want to set this to `true`.
109+
>If true, it adds the overlay window on Android's system window layer and it will ask you for the overlay permission by taking you to the Android's settings screen when you first set up. If set to false, it will automatically add the overlay on each application window. In most cases, you want to set this to `true`.
111110
Default is `true`.
112111

113112
* notification - [boolean, string(optional)]
@@ -124,9 +123,7 @@ Provided Modules
124123
#### CpuUsageModule
125124

126125
`default`
127-
> Collects total and app cpu usage % by reading `/proc/stat` and `/proc/[myPid]/stat` respectively.
128-
129-
Note: CpuUsageModule will be no-op on Android O and above. Please see this [issue](https://github.com/Manabu-GT/DebugOverlay-Android/issues/11) for why.
126+
> Collects app-total and app-relative CPU usage percentages based on the configured interval (default 1000 ms) by reading `/proc/self/stat`.
130127
131128
#### MemInfoModule
132129

@@ -149,8 +146,6 @@ If low memory situation is detected by reading [lowMemory](https://developer.and
149146
`optional`
150147
> Collects each cpu core's current and max frequency by reading `/sys/devices/system/cpu/cpu[num]/cpufreq/scaling_cur_freq` and `/sys/devices/system/cpu/cpu[num]/cpufreq/cpuinfo_max_freq` respectively.
151148
152-
Note: CpuFreqModule will be no-op on Android O and above. Please see this [issue](https://github.com/Manabu-GT/DebugOverlay-Android/issues/11) for why.
153-
154149
Extension Modules (available separately)
155150
------
156151
#### TimberModule
@@ -295,7 +290,7 @@ Thanks for reading!
295290
License
296291
----------
297292

298-
Copyright 2017 Manabu Shimobe
293+
Copyright 2017–2025 Manabu-GT
299294

300295
Licensed under the Apache License, Version 2.0 (the "License");
301296
you may not use this file except in compliance with the License.
@@ -309,11 +304,11 @@ License
309304
See the License for the specific language governing permissions and
310305
limitations under the License.
311306

312-
[1]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/master/debugoverlay/src/main/java/com/ms_square/debugoverlay/modules/LogcatLineFilter.java
313-
[2]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/master/debugoverlay/src/main/java/com/ms_square/debugoverlay/modules/LogcatLineColorScheme.java
314-
[3]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/master/debugoverlay/src/main/java/com/ms_square/debugoverlay/OverlayModule.java
315-
[4]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/master/debugoverlay/src/main/java/com/ms_square/debugoverlay/DataModule.java
316-
[5]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/master/debugoverlay/src/main/java/com/ms_square/debugoverlay/ViewModule.java
317-
[6]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/master/debugoverlay/src/main/java/com/ms_square/debugoverlay/modules/SimpleViewModule.java
318-
[7]: https://github.com/Manabu-GT/DebugOverlay-Android/tree/master/sample
319-
[8]: https://github.com/Manabu-GT/DebugOverlay-Android/tree/master/sample/src/main/java/com/ms_square/debugoverlay/sample/IPAddressDataModule.java
307+
[1]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/main/debugoverlay/src/main/java/com/ms_square/debugoverlay/modules/LogcatLineFilter.java
308+
[2]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/main/debugoverlay/src/main/java/com/ms_square/debugoverlay/modules/LogcatLineColorScheme.java
309+
[3]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/main/debugoverlay/src/main/java/com/ms_square/debugoverlay/OverlayModule.java
310+
[4]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/main/debugoverlay/src/main/java/com/ms_square/debugoverlay/DataModule.java
311+
[5]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/main/debugoverlay/src/main/java/com/ms_square/debugoverlay/ViewModule.java
312+
[6]: https://github.com/Manabu-GT/DebugOverlay-Android/blob/main/debugoverlay/src/main/java/com/ms_square/debugoverlay/modules/SimpleViewModule.java
313+
[7]: https://github.com/Manabu-GT/DebugOverlay-Android/tree/main/sample
314+
[8]: https://github.com/Manabu-GT/DebugOverlay-Android/tree/main/sample/src/main/java/com/ms_square/debugoverlay/sample/IPAddressDataModule.java

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ RELEASE_SIGNING_ENABLED=true
3131
# For maven central
3232
GROUP=com.ms-square
3333
POM_ARTIFACT_ID=debugoverlay
34-
VERSION_NAME=1.1.3
34+
VERSION_NAME=1.1.4
3535

3636
POM_URL=https://github.com/Manabu-GT/DebugOverlay-Android
3737
POM_NAME=DebugOverlay for Android

0 commit comments

Comments
 (0)