Offlin33er commited on
Commit
5823889
·
verified ·
1 Parent(s): 5d52835

README: M5+M6 shipped — roadmap complete

Browse files
Files changed (1) hide show
  1. README.md +40 -21
README.md CHANGED
@@ -2,12 +2,13 @@
2
 
3
  A sophisticated Android browser built on **GeckoView** with:
4
 
5
- - **Real WebExtensions support** — the Firefox add-on model, powered by `WebExtensionController`
6
  - **Built-in developer console** — in-page inspector (Eruda) + native console screen + remote debugging from desktop Firefox DevTools
7
- - **Add-ons manager** — list installed extensions, enable/disable per add-on
8
  - Multi-tab engine, tab tray, session restore, loading bar, history autocomplete
 
 
9
 
10
- ## Status — milestones shipped
11
 
12
  | Milestone | Status |
13
  |---|---|
@@ -16,31 +17,40 @@ A sophisticated Android browser built on **GeckoView** with:
16
  | M2 — toolbar polish: loading bar, live URL sync, back/fwd states, history autocomplete | ✅ v0.3.0 |
17
  | M3 — add-ons manager screen (list, enable/disable) | ✅ v0.4.0 |
18
  | M4 — full native Console screen | ✅ v0.4.0 |
19
- | M5 — AMO `.xpi` install flow with permission prompts | next |
20
- | M6 — privacy, storage, downloads, reader mode, release build | planned |
 
 
 
 
 
 
 
 
 
 
 
 
 
21
 
22
  ## Build it
23
 
24
  1. Install [Android Studio](https://developer.android.com/studio) (2024.2 or newer).
25
- 2. Clone this repo (or download as zip): https://huggingface.co/datasets/Offlin33er/nova-browser
26
- 3. Open the folder in Android Studio and let it sync.
27
  4. Download the inspector bundle once:
28
  ```
29
  curl -L -o app/src/main/assets/devconsole/eruda.min.js \
30
  https://cdn.jsdelivr.net/npm/eruda/eruda.min.js
31
  ```
32
- (`eruda-loader.js` also falls back to the CDN at runtime if the file is missing.)
33
- 5. Run ▶ on a device or emulator (minSdk 26 — required by GeckoView 147).
34
-
35
- Prebuilt APKs: see [`apk/`](apk/) (e.g. `nova-browser-0.4.0-debug.apk`).
36
 
37
  ## Dependency pins (verified, cloud-build tested)
38
 
39
  | Dependency | Version |
40
  |---|---|
41
  | `org.mozilla.geckoview:geckoview` (stable) | `147.0.20260212191108` — [maven.mozilla.org](https://maven.mozilla.org/maven2/org/mozilla/geckoview/) |
42
- | AGP | 8.9.1 |
43
- | Gradle | 8.11.1 |
44
  | Kotlin | 2.2.21 + built-in Compose compiler plugin |
45
  | Compose BOM | 2024.09.03 |
46
  | minSdk / compileSdk | 26 / 36 |
@@ -49,11 +59,12 @@ Prebuilt APKs: see [`apk/`](apk/) (e.g. `nova-browser-0.4.0-debug.apk`).
49
 
50
  ```
51
  app/src/main/java/dev/nova/browser/
52
- BrowserActivity.kt — activity: runtime, UI shell, overlays, restore, intents
 
53
  TabManager.kt — one GeckoSession per tab, session persistence/restore,
54
- nav/loading state, history, extension registry
55
  TabTray.kt — M1 full-screen tab tray
56
- ExtensionManagerScreen.kt — M3 add-ons manager (list, enable/disable)
57
  ConsoleScreen.kt — M4 full console screen
58
  app/src/main/assets/devconsole/
59
  manifest.json — privileged built-in extension (geckoViewAddons, nativeMessaging)
@@ -63,13 +74,21 @@ app/src/main/assets/devconsole/
63
 
64
  ## Dev console — the layers
65
 
66
- 1. **In-page inspector**: the bundled `devconsole@nova` extension injects [Eruda](https://github.com/liriliri/eruda) into every page (console, DOM, network).
67
- 2. **Native console screen**: console output is forwarded over GeckoView **native messaging** (`sendNativeMessage("browser", ...)`) and shown in the full-screen Console screen (newest first, clearable), with a 3-line preview in the main shell.
68
- 3. **Remote debugging**: `runtime.settings.setRemoteDebuggingEnabled(true)` — desktop Firefox DevTools attach via `about:debugging` over USB/Wi-Fi.
 
 
 
 
 
 
69
 
70
- ## Add-ons manager (M3)
71
 
72
- Lists installed extensions from `WebExtensionController.list()` with name/version/description and enable/disable switches (`controller.enable/disable(ext, EnableSource.USER)`). Enabled state is tracked by Nova (no stable `isEnabled` accessor in current GV javadoc). AMO installs arrive in M5.
 
 
73
 
74
  ## License
75
 
 
2
 
3
  A sophisticated Android browser built on **GeckoView** with:
4
 
5
+ - **Real WebExtensions support** — install from AMO, enable/disable/uninstall, permission prompts
6
  - **Built-in developer console** — in-page inspector (Eruda) + native console screen + remote debugging from desktop Firefox DevTools
 
7
  - Multi-tab engine, tab tray, session restore, loading bar, history autocomplete
8
+ - **Tracking protection** enabled out of the box
9
+ - **Release builds with per-ABI splits** — a phone-sized APK instead of a 517 MB universal debug blob
10
 
11
+ ## Status — milestones shipped (roadmap complete ✅)
12
 
13
  | Milestone | Status |
14
  |---|---|
 
17
  | M2 — toolbar polish: loading bar, live URL sync, back/fwd states, history autocomplete | ✅ v0.3.0 |
18
  | M3 — add-ons manager screen (list, enable/disable) | ✅ v0.4.0 |
19
  | M4 — full native Console screen | ✅ v0.4.0 |
20
+ | M5 — AMO `.xpi` install flow with permission prompts + uninstall | ✅ v0.5.0 |
21
+ | M6 — release build with ABI splits, debug-signed + tracking protection | ✅ v0.5.0 |
22
+ | Deferred (post-1.0): downloads manager, reader mode, private-mode UI, Chrome-style polish | — |
23
+
24
+ ## Which APK to install
25
+
26
+ In [`apk/`](apk/):
27
+
28
+ | File | Use |
29
+ |---|---|
30
+ | `nova-browser-0.5.0-arm64-release.apk` | **Most modern phones** — small, optimized |
31
+ | `nova-browser-0.5.0-universal-release.apk` | Any device (larger) |
32
+ | `nova-browser-0.5.0-debug.apk` | Debug build with all ABIs |
33
+
34
+ Release builds are debug-signed (installable for testing); ship with a real keystore for distribution.
35
 
36
  ## Build it
37
 
38
  1. Install [Android Studio](https://developer.android.com/studio) (2024.2 or newer).
39
+ 2. Clone this repo: https://huggingface.co/datasets/Offlin33er/nova-browser
40
+ 3. Open in Android Studio and sync.
41
  4. Download the inspector bundle once:
42
  ```
43
  curl -L -o app/src/main/assets/devconsole/eruda.min.js \
44
  https://cdn.jsdelivr.net/npm/eruda/eruda.min.js
45
  ```
46
+ 5. Run ▶ on a device or emulator (minSdk 26).
 
 
 
47
 
48
  ## Dependency pins (verified, cloud-build tested)
49
 
50
  | Dependency | Version |
51
  |---|---|
52
  | `org.mozilla.geckoview:geckoview` (stable) | `147.0.20260212191108` — [maven.mozilla.org](https://maven.mozilla.org/maven2/org/mozilla/geckoview/) |
53
+ | AGP / Gradle | 8.9.1 / 8.11.1 |
 
54
  | Kotlin | 2.2.21 + built-in Compose compiler plugin |
55
  | Compose BOM | 2024.09.03 |
56
  | minSdk / compileSdk | 26 / 36 |
 
59
 
60
  ```
61
  app/src/main/java/dev/nova/browser/
62
+ BrowserActivity.kt — activity: runtime, UI shell, overlays, restore, intents,
63
+ install-permission prompt delegate
64
  TabManager.kt — one GeckoSession per tab, session persistence/restore,
65
+ nav/loading state, history, extension registry + installs
66
  TabTray.kt — M1 full-screen tab tray
67
+ ExtensionManagerScreen.kt — M3/M5 add-ons manager (list, toggle, uninstall, AMO install)
68
  ConsoleScreen.kt — M4 full console screen
69
  app/src/main/assets/devconsole/
70
  manifest.json — privileged built-in extension (geckoViewAddons, nativeMessaging)
 
74
 
75
  ## Dev console — the layers
76
 
77
+ 1. **In-page inspector**: bundled `devconsole@nova` extension injects [Eruda](https://github.com/liriliri/eruda) into every page.
78
+ 2. **Native console screen**: console output bridged over **native messaging** into the full-screen Console screen (newest first, clearable) + a 3-line shell preview.
79
+ 3. **Remote debugging**: `runtime.settings.setRemoteDebuggingEnabled(true)` — desktop Firefox DevTools attach via `about:debugging`.
80
+
81
+ ## Extensions
82
+
83
+ - **Bundled**: `devconsole@nova` (privileged, `ensureBuiltIn`).
84
+ - **AMO installs (M5)**: paste an AMO add-on URL or `.xpi` link in the Add-ons screen → `WebExtensionController.install(uri)`; Gecko downloads + validates the Mozilla signature, then `onInstallPromptRequest` surfaces a permission dialog (Allow/Deny). Installs persist across restarts. Uninstall available for non-builtin add-ons.
85
+ - **Privacy**: runtime tracking protection policy (`RECOMMENDED`) + per-session opt-in.
86
 
87
+ ## Known simplifications
88
 
89
+ - Session restore is URL-level (no scroll/state capture — `saveState()`/`restoreState()` is the next step).
90
+ - Install prompt grants `permissions` but not private-mode or data-collection flags (safe defaults).
91
+ - Release builds are debug-signed and not minified — R8 pass still to do.
92
 
93
  ## License
94