diff --git a/README.md b/README.md index 8487a81c..484ebc88 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ See the official [plugin documentation](https://www.appdevforall.org/codeonthego | [`vector-search-plugin/`](vector-search-plugin/) | Semantic code search using embeddings and vector similarity. | | [`get-ai-models/`](get-ai-models/) | Bottom-drawer catalog of curated, fully-open GGUF model files; downloads one to `/sdcard/Download` and verifies its SHA-256. | | [`project-to-template/`](project-to-template/) | Converts the open Android project into a Code On The Go (.cgt) template and installs it into the IDE's New Project picker. | -| [`pair-programming-plugin/`](pair-programming-plugin/) | Real-time pair programming across two devices on the same WiFi — host or join a session and sync edits and cursor presence live over the local network. | +| [`code-together/`](code-together/) | Real-time pair programming across two devices on the same WiFi — host or join a session and sync edits and cursor presence live over the local network. | ## Building a plugin diff --git a/pair-programming-plugin/.gitignore b/code-together/.gitignore similarity index 100% rename from pair-programming-plugin/.gitignore rename to code-together/.gitignore diff --git a/pair-programming-plugin/README.md b/code-together/README.md similarity index 75% rename from pair-programming-plugin/README.md rename to code-together/README.md index 89bf36fd..1724a7fa 100644 --- a/pair-programming-plugin/README.md +++ b/code-together/README.md @@ -1,4 +1,4 @@ -# Pair +# Code Together A plugin for [CodeOnTheGo](https://github.com/appdevforall/CodeOnTheGo) that turns the IDE into a real-time collaborative editor. Two phones on the same WiFi share one editing session: one device **hosts**, others **join** by typing the host's `ip:port` or scanning its QR code, and from then on edits, cursors, and file opens flow between devices as they happen — no server, no cloud, no signup. @@ -7,8 +7,8 @@ It surfaces as a **Pair** tab in the editor. Host a session and an invite card s ## Building ```sh -cd pair -./gradlew clean assemblePlugin +cd code-together +../gradlew clean assemblePlugin ``` The `.cgp` lands in `build/plugin/`. Install it from inside CodeOnTheGo via the Plugin Manager. Always `clean` first — the plugin builder copies the built APK into the `.cgp` and then deletes the source APK, so an incremental build can package an empty artifact. @@ -26,7 +26,7 @@ The `.cgp` lands in `build/plugin/`. Install it from inside CodeOnTheGo via the ## Source layout ``` -pair/ +code-together/ ├── build.gradle.kts, settings.gradle.kts, proguard-rules.pro └── src/main/ ├── AndroidManifest.xml plugin id, main class, icons, permissions @@ -43,13 +43,13 @@ pair/ - `../libs/plugin-api.jar` — the plugin API surface (`IPlugin`, extensions, `Ide*Service`); `compileOnly`, provided by the IDE at runtime. - `../libs/gradle-plugin.jar` — the `com.itsaky.androidide.plugins.build` Gradle plugin that packages the `.cgp`. -- `../libs/eventbus-events.jar` — the editor and file `*Event` types Pair subscribes to on the EventBus. -- `../libs/shared.jar` — `com.itsaky.androidide.models.Range`, the type of `DocumentChangeEvent.changeRange` that Pair reads. +- `../libs/eventbus-events.jar` — the editor and file `*Event` types Code Together subscribes to on the EventBus. +- `libs/shared.jar` — `com.itsaky.androidide.models.Range`, the type of `DocumentChangeEvent.changeRange` that Code Together reads. Jetpack Compose is linked `compileOnly` (host-provided), not bundled. -> **Note:** Pair requires an extended `plugin-api` beyond the current `stage` baseline — `IdeProjectService.openProject(File)` (open a project after a pull-model sync) and `IdeEditorService.showPeerCursor` / `hidePeerCursor` / `clearPeerCursors` (inline remote-cursor decoration). These land on the `feat/ADFA-4419-remote-peer-editor-decoration` branch. If `assemblePlugin` fails with unresolved references to those symbols, the shared `libs/` jars are older than the API Pair needs; refresh them from a CodeOnTheGo build that includes the extensions (`../scripts/update-libs.sh --local --ref feat/ADFA-4419-remote-peer-editor-decoration`). +> **Note:** Code Together requires an extended `plugin-api` beyond the current `stage` baseline — `IdeProjectService.openProject(File)` (open a project after a pull-model sync) and `IdeEditorService.showPeerCursor` / `hidePeerCursor` / `clearPeerCursors` (inline remote-cursor decoration). These land on the `feat/ADFA-4419-remote-peer-editor-decoration` branch. If `assemblePlugin` fails with unresolved references to those symbols, the shared `libs/` jars are older than the API Code Together needs; refresh them from a CodeOnTheGo build that includes the extensions (`../scripts/update-libs.sh --local --ref feat/ADFA-4419-remote-peer-editor-decoration`). ## License -Pair is an open-source example plugin for Code on the Go. Its source is licensed per the surrounding `plugin-examples` repository (see `LICENSE` at the repo root). It makes no cloud calls — all traffic stays on the local network between the paired devices. +Code Together is an open-source example plugin for Code on the Go. Its source is licensed per the surrounding `plugin-examples` repository (see `LICENSE` at the repo root). It makes no cloud calls — all traffic stays on the local network between the paired devices. diff --git a/pair-programming-plugin/build.gradle.kts b/code-together/build.gradle.kts similarity index 98% rename from pair-programming-plugin/build.gradle.kts rename to code-together/build.gradle.kts index d763c3a0..6167494a 100644 --- a/pair-programming-plugin/build.gradle.kts +++ b/code-together/build.gradle.kts @@ -6,7 +6,7 @@ plugins { } pluginBuilder { - pluginName = "pair-programming-plugin" + pluginName = "code-together" } android { diff --git a/pair-programming-plugin/pair-programming-plugin-documentation.html b/code-together/code-together.html similarity index 97% rename from pair-programming-plugin/pair-programming-plugin-documentation.html rename to code-together/code-together.html index ca001b9f..9adf0465 100644 --- a/pair-programming-plugin/pair-programming-plugin-documentation.html +++ b/code-together/code-together.html @@ -3,7 +3,7 @@ -Pair Plugin Documentation +Code Together