Skip to content

Commit 0750136

Browse files
Update README.md
1 parent e07fca1 commit 0750136

1 file changed

Lines changed: 56 additions & 2 deletions

File tree

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,56 @@
1-
# android-device-explorer
2-
A Godot Editor plugin for exploring and managing Android device file system
1+
# <img src="https://raw.githubusercontent.com/syntaxerror247/android-device-explorer/refs/heads/main/addons/android-device-explorer/device_explorer_icon.svg" width="24"> Android Device Explorer
2+
3+
An editor plugin for **Godot** that lets you explore and manage the filesystem of connected ADB devices directly from within the editor.
4+
5+
## Example Use Cases
6+
7+
- Inspect logs or cached data generated by your app
8+
- Quickly push test files into your app's private data directory
9+
- Retrieve and debug files stored by your app
10+
- Upload, download, create, or delete files from device storage without leaving the editor
11+
12+
## Getting Started
13+
14+
### Prerequisites
15+
16+
* Android device or emulator
17+
* ADB (Android Debug Bridge) installed
18+
* USB debugging enabled on your device
19+
* A debug build of your app installed on the device (Only Required to access app's private data)
20+
21+
22+
### Setup
23+
24+
1. Download the latest release from the [GitHub Releases](https://github.com/syntaxerror247/android-device-explorer/releases)
25+
26+
2. Extract and copy the plugin into your project's `addons` folder:
27+
```
28+
[Project Root]/addons/android-device-explorer/
29+
```
30+
31+
3. Open your project in Godot
32+
33+
4. Enable the plugin:
34+
- Go to `Project > Project Settings > Plugins`
35+
- Enable **`Android Device Explorer`**
36+
37+
5. Configure the plugin:
38+
- **ADB Path**: Path to the `adb` executable on your system
39+
- **Package Name**: Your app's debug package name (example, `org.godotengine.editor.v4.debug`)
40+
<img width="450" height="275" alt="Config Window" src="https://github.com/user-attachments/assets/fd5260d9-6b3e-437d-ba3c-4c94e79858ce" />
41+
42+
43+
6. Connect your device:
44+
- Connect your device and ensure USB debugging is enabled
45+
- Or, start your Android emulator
46+
47+
## Usage
48+
49+
- Open the Device Explorer dock in the editor
50+
- Click the **Reload** button to detect connected devices
51+
- Browse your device's filesystem
52+
- Upload, download, create, or delete files as needed
53+
54+
<img width="368" height="652" alt="Device Explorer" src="https://github.com/user-attachments/assets/53fbc0c4-17f8-4928-bf7e-8df2d1e6e0f5" />
55+
56+

0 commit comments

Comments
 (0)