buoy_core 0.3.4
buoy_core: ^0.3.4 copied to clipboard
Core registry, account-configured Desktop sync, floating menu and settings for Buoy tools in Flutter debug builds.
buoy_core #
Core provides Buoy's Flutter menu, tool registry, settings storage, and device sync client. Most apps should start with the buoy umbrella or a specific tool package; core alone does not install the inspection tools.
Requirements #
Use a Flutter debug build and a Free or Pro Buoy account key. These packages require Dart 3.9 or later, below 4.0, and Flutter 3.27 or later; your Flutter installation must satisfy both constraints. The Buoy widget does not start its tools in profile or release builds, including with Pro.
Install and integrate #
flutter pub add buoy_core
Import package:buoy_core/buoy_core.dart, register the tools you implement, and mount BuoyDevTools through your app builder. This fragment goes inside your existing MaterialApp:
builder: (context, child) => BuoyDevTools(
licenseKey: const String.fromEnvironment('BUOY_KEY'),
child: child ?? const SizedBox.shrink(),
),
Get an account key and run flutter run --dart-define=BUOY_KEY=YOUR_LICENSE_KEY. Follow the custom-tool guide for a complete registration example. Open your registered tool and confirm that its panel renders before adding sync.
The floating menu shows an Admin badge by default, matching React Native. Set userRole to BuoyUserRole.internal or BuoyUserRole.user to change it. Tapping the badge opens the tool dial.
Public building blocks #
BuoyDevToolsmounts the menu and manages its account and connection lifecycle.BuoySyncClientconnects device adapters to the broker.ToolSyncAdapterdefines snapshots, subscriptions, and supported actions.BuoyStoragepersists tool settings.BuoyFloatingToolsopens independent strips above the tool modals.BuoyDevToolsmounts their host; eachFloatingToolsaves its own position.
A custom tool needs its own adapter to expose remote data or actions. Registering a menu entry alone does not implement that adapter.
Desktop and MCP #
Open Buoy Desktop, sign in, and select the connected device. The default broker port is 42831. The iOS Simulator uses localhost; the Android emulator maps localhost to its host address. For a physical device, set socketUrl: 'http://YOUR_COMPUTER_LAN_IP:42831' on BuoyDevTools and use a network that can reach your computer.
MCP needs separate process account configuration and Pro access. Remote capabilities depend on each tool's adapter. Account validation makes network requests, and device sessions can cross your LAN. See Telemetry for data-flow details.
License #
Proprietary software. © Buoy LLC. See the Terms of Service and pricing.