@arenahito/droid-webscr 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 arenahito
+
+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.

package/README.md

@@ -0,0 +1,83 @@
+# droid-webscr
+
+droid-webscr is a local Android screen streaming and control tool. It runs a small
+Node.js agent on your machine, pushes a temporary Android-side server through ADB,
+and opens a browser UI for viewing and controlling an authorized Android device.
+
+The project is under active development. Expect CLI and protocol details to keep
+moving until the first stable release.
+
+## Features
+
+- Browser-based Android screen viewing with WebCodecs.
+- Pointer, keyboard, text, and Android hardware-button control.
+- USB, emulator, and network ADB device discovery.
+- Device log viewing and live log tailing.
+- Runtime bind controls for local or authenticated shared access.
+- Android server verification backed by emulator acceptance checks.
+
+## Installation
+
+```sh
+npm install -g @arenahito/droid-webscr
+```
+
+You can also run it without installing it globally:
+
+```sh
+npx @arenahito/droid-webscr
+```
+
+The installed command is:
+
+```sh
+droid-webscr
+```
+
+## Prerequisites
+
+- Node.js 24 or newer.
+- Android SDK platform-tools with `adb` available on `PATH`.
+- An Android emulator or device visible in `adb devices -l`.
+- Device authorization completed when using a physical Android device.
+- Chrome or Edge for the browser UI.
+
+## Usage
+
+Start the local agent:
+
+```sh
+droid-webscr
+```
+
+By default the agent listens on:
+
+```text
+http://127.0.0.1:7391
+```
+
+Open the web UI, select an authorized device, and start a session. The session
+streams the Android display into the browser and sends control frames back to the
+device through the local agent.
+
+The UI supports:
+
+- starting and stopping a device session;
+- selecting video bitrate and frame rate;
+- pointer, keyboard, and text input;
+- back, home, overview, power, and volume actions;
+- rotation controls;
+- device log history and live log tailing;
+- connecting a network ADB endpoint such as `192.168.1.40:5555`.
+
+## Configuration
+
+droid-webscr currently starts with local-only defaults. The agent listens on
+`127.0.0.1:7391`, and clipboard sync is disabled.
+
+Runtime access settings can be changed from the web UI. Non-local bind addresses
+require an auth token, and clipboard sync must be enabled explicitly.
+
+## License
+
+MIT

package/dist/bin.d.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+import { AgentRuntime } from './main.js';
+import '@droid-webscr/adb';
+import '@droid-webscr/config';
+
+interface CliIo {
+    stderr(value: string): void;
+    stdout(value: string): void;
+}
+interface CliRuntime {
+    readonly packageVersion?: string | undefined;
+    readonly startAgent?: (() => Promise<AgentRuntime>) | undefined;
+    readonly stderr?: ((value: string) => void) | undefined;
+    readonly stdout?: ((value: string) => void) | undefined;
+}
+declare function runCli(argv: readonly string[], runtime?: CliRuntime): Promise<number>;
+declare function createCliHelp(): string;
+
+export { type CliIo, type CliRuntime, createCliHelp, runCli };